aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorRafael G. Martins <rafael@rafaelmartins.eng.br>2010-07-02 01:05:01 -0300
committerRafael G. Martins <rafael@rafaelmartins.eng.br>2010-07-02 01:05:01 -0300
commitc3ecee76bfdda536470954aab10a7aab0c3a042e (patch)
tree68b22dc32cf1218ea1826ea8a3056c2a72071e52 /docs
parentremoved tag 0.2 (diff)
downloadg-octave-c3ecee76bfdda536470954aab10a7aab0c3a042e.tar.gz
g-octave-c3ecee76bfdda536470954aab10a7aab0c3a042e.tar.bz2
g-octave-c3ecee76bfdda536470954aab10a7aab0c3a042e.zip
a bunch of documentation changes and fixes to the release0.2
Diffstat (limited to 'docs')
-rw-r--r--docs/conf.py2
-rw-r--r--docs/development.rst30
-rw-r--r--docs/index.rst2
-rw-r--r--docs/userguide.rst35
4 files changed, 57 insertions, 12 deletions
diff --git a/docs/conf.py b/docs/conf.py
index f470b89..a417a3e 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -47,7 +47,7 @@ copyright = u'2010, Rafael Goncalves Martins'
# The short X.Y version.
version = '0.2'
# The full version, including alpha/beta/rc tags.
-release = '0.2_rc1'
+release = '0.2'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
diff --git a/docs/development.rst b/docs/development.rst
index ed171b5..b9077df 100644
--- a/docs/development.rst
+++ b/docs/development.rst
@@ -1,7 +1,7 @@
Development
===========
-:Source code: http://hg.rafaelmartins.eng.br/g-octave/
+:Source code: http://g-octave.rafaelmartins.eng.br/hg/
:Bug tracker: http://g-octave.rafaelmartins.eng.br/
.. _`bug tracker`: http://g-octave.rafaelmartins.eng.br/
@@ -13,8 +13,8 @@ You can run the tests suites using the script ``run_tests.py`` that can be
found in the directory ``scripts`` in the `source tarballs`_ (since 0.1) or
in the `Mercurial repository`_
-.. _`source tarballs`: http://files.rafaelmartins.eng.br/distfiles/g-octave/
-.. _`Mercurial repository`: http://hg.rafaelmartins.eng.br/g-octave/
+.. _`source tarballs`: http://g-octave.rafaelmartins.eng.br/distfiles/releases/
+.. _`Mercurial repository`: http://g-octave.rafaelmartins.eng.br/hg/
::
@@ -24,6 +24,30 @@ If some test is broken, please create a ticket in the `bug tracker`_.
A quick registration is needed.
+Creating source tarballs from the octave-forge SVN repository
+-------------------------------------------------------------
+
+We have a script to create source tarballs for all the packages,
+using the latest stable revision from the octave-forge SVN repo.
+
+To use it, add a ``pkg_cache`` option to your configuration file with
+the directory where you want to save the generated tarballs and, after
+clone the Mercurial repository or download the source tarball, run from
+the root of the source tree::
+
+ $ scripts/package_sources.py
+
+
+Creating a package database from the previously created source tarballs
+-----------------------------------------------------------------------
+
+You should want to also create a package database. For this, keep the
+``pkg_cache`` option in your configuration file pointing to the directory
+with your source tarballs and run from the root of the source tree::
+
+ $ scripts/package_database.py /path/to/your/new/database.tar.gz
+
+
Sending patches
---------------
diff --git a/docs/index.rst b/docs/index.rst
index 2855cfe..2906376 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -7,7 +7,7 @@ Welcome to g-Octave's documentation!
====================================
:Author: Rafael Goncalves Martins
-:Source code: http://hg.rafaelmartins.eng.br/g-octave/
+:Source code: http://g-octave.rafaelmartins.eng.br/hg/
:Bug tracker: http://g-octave.rafaelmartins.eng.br/
:Version: |release|
diff --git a/docs/userguide.rst b/docs/userguide.rst
index 448d3e6..da81089 100644
--- a/docs/userguide.rst
+++ b/docs/userguide.rst
@@ -9,9 +9,11 @@ Installing g-Octave
-------------------
The ebuilds for g-Octave will be available on the Portage tree as soon
-as possible. For now, they can be found on my overlay:
+as possible. For now, they can be found on the Gentoo ``science`` overlay.
+To install it with ``layman`` and ``git`` installed, type::
+
+ # layman -a science
-http://overlay.rafaelmartins.eng.br/
After you have the overlay installed, you can install the package, using: ::
@@ -35,16 +37,16 @@ release will need to unmask the ebuild too, adding this to
The source code of g-Octave can be found in this Mercurial repository:
-http://hg.rafaelmartins.eng.br/g-octave/
+http://g-octave.rafaelmartins.eng.br/hg/
You can clone the mercurial repository using this command (with Mercurial
installed, of course)::
- $ hg clone http://hg.rafaelmartins.eng.br/g-octave/
+ $ hg clone http://g-octave.rafaelmartins.eng.br/hg/ g-octave
The release tarballs can be found here:
-http://files.rafaelmartins.eng.br/distfiles/g-octave/
+http://g-octave.rafaelmartins.eng.br/distfiles/releases/
Configuring g-Octave
@@ -106,8 +108,8 @@ For example: ::
# g-octave control-1.0.11
-g-octave command tool supports some options for the installation of
-packages:
+``g-octave`` command-line tool supports some options for the installation
+of packages:
``-a`` or ``--ask``
Ask before install the package
@@ -123,6 +125,25 @@ or ::
# g-octave -i packagename
+Installing packages from the octave-forge SVN repository
+--------------------------------------------------------
+
+If you want to test some new feature, or to use the new version of the
+packages ever, you'll like to install your packages directly from the
+SVN repository.
+
+To install a package from SVN, type::
+
+ # g-octave packagename-9999
+
+All the common g-octave options for install packages are allowed, and
+the special version ``9999`` says to g-octave that you want to use the
+SVN version.
+
+In order to be able to install packages from svn you need to install
+g-octave with the USE flag ``svn`` enabled.
+
+
Uninstalling packages
---------------------