diff options
| author |   Ulrich Müller <ulm@gentoo.org> | 2014-03-20 19:35:25 +0100 |
|---|---|---|
| committer | Ulrich Müller <ulm@gentoo.org> | 2014-03-20 19:35:25 +0100 |
| commit | 66c4b410b6a45c1c3fd4d2acc9edf77b339143ce (patch) | |
| tree | 42f5c26dbe119d8a811149f0f9b599000f576e18 | |
| parent | Remove duplicate heading in developer guide. (diff) | |
| download | eselect-66c4b410b6a45c1c3fd4d2acc9edf77b339143ce.tar.gz eselect-66c4b410b6a45c1c3fd4d2acc9edf77b339143ce.tar.bz2 eselect-66c4b410b6a45c1c3fd4d2acc9edf77b339143ce.zip | |
Update list of standard actions in documentation.
* doc/user-guide.txt: Mention the "unset" action also here.
* doc/developer-guide.txt: Reorder the standard action names to be
congruent with the user guide.
| -rw-r--r-- | ChangeLog | 4 | ||||
| -rw-r--r-- | doc/developer-guide.txt | 16 | ||||
| -rw-r--r-- | doc/user-guide.txt | 8 |
3 files changed, 17 insertions, 11 deletions
@@ -1,7 +1,11 @@ 2014-03-20 Ulrich Müller <ulm@gentoo.org> + * doc/user-guide.txt: Mention the "unset" action also here. + * doc/developer-guide.txt: Remove duplicate heading, because rst2html --report=info complains about it. + Reorder the standard action names to be congruent with the + user guide. * Makefile.am (%.html): Strip comments from html output, in order to suppress wrong mode information in Emacs local variables. diff --git a/doc/developer-guide.txt b/doc/developer-guide.txt index 03b6846..2191ad5 100644 --- a/doc/developer-guide.txt +++ b/doc/developer-guide.txt @@ -178,27 +178,27 @@ usage Display a usage message. Automatic. version Display the current version. Automatic. -show - Used to display the current provider of a symlink, or the currently - installed module, or the current status. list Used to display all available providers of a symlink, or all available modules. +show + Used to display the current provider of a symlink, or the currently + installed module, or the current status. set Used to set a new provider or a symlink. unset Used to unset the current provider, or to remove a symlink. +update + Used to automatically select a new provider for a symlink (as + opposed to ``set``, which generally takes a parameter manually + selecting the provider) or to gather system information that is + vital to further actions. enable Used to enable an optional feature. disable Used to disable an optional feature. scan Read information off the current filesystem. -update - Used to automatically select a new provider for a symlink (as - opposed to ``set``, which generally takes a parameter manually - selecting the provider) or to gather system information that is - vital to further actions. .. Note:: You can override the ``help``, ``usage`` and ``version`` actions. They are provided by default by ``lib/default.eselect``. diff --git a/doc/user-guide.txt b/doc/user-guide.txt index 0afb954..7784d20 100644 --- a/doc/user-guide.txt +++ b/doc/user-guide.txt @@ -111,13 +111,15 @@ show Print the currently active configuration(s). set Select one of the options offered by ``list``. +unset + Deselect the currently active option. +update + Like ``set``, but automatically selects an option rather than taking + a parameter. enable Enable one of the module specific features. disable Disable one of the module specific features. -update - Like ``set``, but automatically selects an option rather than taking - a parameter. scan Gather information about the system and store it for future usage by the module. |