diff options
author | Rafael G. Martins <rafael@rafaelmartins.eng.br> | 2010-07-13 20:21:48 -0300 |
---|---|---|
committer | Rafael G. Martins <rafael@rafaelmartins.eng.br> | 2010-07-13 20:21:48 -0300 |
commit | 033737b22d2a70442aa8a7969fee2df460dc47fa (patch) | |
tree | 40b1cbc3a41ec43704fa1d61955354b00020355d /README.rst | |
parent | started updating the documentation (diff) | |
download | g-octave-033737b22d2a70442aa8a7969fee2df460dc47fa.tar.gz g-octave-033737b22d2a70442aa8a7969fee2df460dc47fa.tar.bz2 g-octave-033737b22d2a70442aa8a7969fee2df460dc47fa.zip |
disabled the logging for the tests. updated all the doc for the next release
Diffstat (limited to 'README.rst')
-rw-r--r-- | README.rst | 125 |
1 files changed, 49 insertions, 76 deletions
@@ -7,7 +7,8 @@ .. _pkgcore: http://www.pkgcore.org/ .. _`Gentoo Linux`: http://www.gentoo.org/ .. _`issue tracker`: http://g-octave.rafaelmartins.eng.br/report -.. _Mercurial: http://mercurial.selenic.com/ +.. _Git: http://git-scm.com/ +.. _PySVN: http://pysvn.tigris.org/ g-octave ======== @@ -39,14 +40,12 @@ What is g-octave ~~~~~~~~~~~~~~~~ `g-octave`_ is a tool that generates and installs ebuilds for `Octave-Forge`_ -packages "on-the-fly" to `Gentoo Linux`_, using Portage_. It's capable to -generate ebuilds and Manifest files for the packages, and to install -them using an autogenerated overlay (named g-octave). `g-octave`_ can also -handle patches to the packages automatically. The command line interface -tries to be very similar to the interface of the **emerge** tool. - -At this moment `g-octave`_ depends on the Portage_ package manager to works, -but the support to Paludis_ and pkgcore_ is planned. +packages "on-the-fly" to `Gentoo Linux`_, using Portage_, Paludis_ or pkgcore_. +It's capable to generate ebuilds and Manifest files (if needed) +for the packages, and to install them using an autogenerated overlay (named +g-octave). `g-octave`_ can also handle patches to the packages automatically. +The command line interface tries to be very similar to the interface of the +**emerge** tool. Dependencies @@ -56,13 +55,14 @@ Dependencies * Python_ 2.6 * Portage_ -* PySVN (optional) +* PySVN_ (optional) +* Paludis_ (optional) +* pkgcore_ (optional) `g-octave`_ also depends on some files, distributed by the maintainer, like the package database (a tarball with the DESCRIPTION file of all the packages), a file with the dependencies and the blacklist, a tarball -with the patches, the eclass *octave-forge*, and a file that list the -updated files. +with the patches and a file that list the updated files. These files are needed because upstream don't ship a package database (they only distribute a tarball with the sources of all the packages, so @@ -72,7 +72,7 @@ or that a new patch is added. All these files are automatically fetched by `g-octave`_ At this time, these files are here: -http://g-octave.rafaelmartins.eng.br/distfiles/db/ +http://soc.dev.gentoo.org/~rafaelmartins/g-octave/db/ Settings @@ -82,61 +82,28 @@ All the settings are centralized on the file */etc/g-octave.cfg*. Please read the comments and change what you need. The recommendation is to keep everything as it is. :) +You can also use environment variables to configure `g-octave`. -Features --------- +http://soc.dev.gentoo.org/~rafaelmartins/g-octave/docs/latest/userguide/#configuring-g-octave + + +Configuring your package manager +-------------------------------- + +g-octave can use all the 3 package managers available on Gentoo Linux: +**Portage**, **Paludis** and **Pkgcore**. + +You just need to setup the option `package_manager` with the lowercase +name of the package manager: `portage`, `paludis`, `pkgcore`. -Below is a list of features implemented or planned to the next releases. - -* Selection of the packages by name-version **(done)** -* Selection of the packages by name (using the latest version available) - **(done)** -* Creation of the ebuilds **(done)** -* Creation of the Manifest files **(done)** -* Creation of the overlay automatically **(done)** -* Installation of the packages **(done)** -* Update of the packages already installed -* Remotion of the installed packages **(done)** -* Installation of the packages with patches automatically **(done)** -* List the packages available to install **(done)** -* Show detailed info about a package **(done)** -* Supports multiple versions of the same package on the tree **(done)** -* The user can force the recreation of an ebuild **(done)** -* The user can force the recreation of the overlay **(done)** -* Resolution of the dependencies of packages from the Portage tree, based - on the dependency list, provided by the maintainer of `g-octave`_ **(done)** -* Installation of multiple packages at once (not only the dependencies) -* Handle updates of the eclass and the auxiliary files automatically **(done)** -* Alert the user if the `g-octave`_ overlay is not appended to the - PORTDIR_OVERLAY environment variable **(done)** -* Portage_ is supported **(done)** -* Paludis_ is supported -* pkgcore_ is supported -* Configuration file to the main settings */etc/g-octave.cfg* **(done)** -* Use colors on the CLI **(done)** -* The user can disable the use of colors on the CLI **(done)** -* Log `g-octave`_ actions to a file -* Can install packages from the octave-forge SVN repository. - - -To-Do ------ - -We have other goals besides implementing the remaining features: - -* Remove the unneeded dependency: pycolors **(done)** -* Remove the unneeded dependency: simplejson **(done)** -* Port to Python_ >= 3.0 -* Improve the code comments -* Improve the error handling -* Improve the overlay management -* Write a man page **(done)** -* Convince upstream to distribute the package database -* Improve the use of `g-octave`_ as a normal user, with "--pretend" -* Improve the script that generates the package database **(done)** -* Improve the details available on the packages list -* Write a testsuite **(done)** -* more... +If you're using Paludis or Pkgcore, you'll need to configure the overlay +in your package manager configuration files. Please check the documentation +of your package manager: + +- Paludis: http://paludis.pioto.org/ +- Pkgcore: http://www.pkgcore.org/ + +Portage works out of the box. CLI options @@ -163,6 +130,9 @@ CLI options *-v, --verbose* Portage makes a lot of noise. +*-u, --update* + try to update a package or all the installed packages + *-C, --unmerge* try to unmerge a package instead of merge @@ -178,7 +148,7 @@ CLI options *--sync* search for updates of the package database, patches and auxiliary files -*--config" +*--config* return a value from the configuration file (/etc/g-octave.cfg) @@ -189,9 +159,13 @@ Install the latest version of *control*: :: # g-octave control -Install the version 1.0.11 of *control*: :: +Install the version 0.3.1 of *control*: :: - # g-octave control-1.0.11 + # g-octave control-0.3.1 + +Upgrade to latest version available of *control*: :: + + # g-octave -u control Remove the package *control*: :: @@ -212,11 +186,10 @@ How can I help? --------------- The users can help testing and reporting bugs in our `issue tracker`_. -If you can help programming in Python_, please take a look at our missing -features and at the To-Do list. :) +If you can help programming in Python_ you're always welcome. :) -`g-octave`_ ebuilds are available on the mercurial repository, or the -Gentoo science overlay +`g-octave`_ ebuilds are available on the Git repository, or the +Gentoo science overlay. Warning @@ -232,11 +205,11 @@ Download Page ------------- You can get the sources here: -http://g-octave.rafaelmartins.eng.br/wiki/DownloadSources +http://soc.dev.gentoo.org/~rafaelmartins/g-octave/releases/ -or checkout the Mercurial_ repository using: :: +or clone the Git_ repository using: :: - $ hg clone http://g-octave.rafaelmartins.eng.br/hg/ + $ git clone git://git.overlays.gentoo.org/proj/g-octave.git Authors |