* [gentoo-commits] eselect r663 - trunk/doc
@ 2009-09-19 11:15 Ulrich Mueller (ulm)
0 siblings, 0 replies; only message in thread
From: Ulrich Mueller (ulm) @ 2009-09-19 11:15 UTC (permalink / raw
To: gentoo-commits
Author: ulm
Date: 2009-09-19 11:15:16 +0000 (Sat, 19 Sep 2009)
New Revision: 663
Modified:
trunk/doc/user-guide.txt
Log:
Use consistent capitalisation. Fix a typo.
Modified: trunk/doc/user-guide.txt
===================================================================
--- trunk/doc/user-guide.txt 2009-09-19 05:51:07 UTC (rev 662)
+++ trunk/doc/user-guide.txt 2009-09-19 11:15:16 UTC (rev 663)
@@ -21,7 +21,7 @@
A module provides several actions. Actions typically either display some
information (``list`` and ``show`` actions are common) or update the system
somehow (for example, ``set`` and ``update``). Each module also provides
-``help`` and ``usage`` actions which explains how to use the module.
+``help`` and ``usage`` actions which explain how to use the module.
Some modules install symlinks to the main program. eselect handles these
intelligently -- for example, it realises that ``profile-config list`` should be
@@ -38,7 +38,7 @@
to eselect's action framework, there is no longer any need to remember or
look up dozens of ``-x`` style switches for each tool. The output format
used by modules is also standardised.
-Consistent Help format
+Consistent help format
All eselect modules provide easily accessible help documentation via the
``help`` and ``usage`` actions.
Consistent tool naming
@@ -46,7 +46,7 @@
names. To see a list of available tools, simply run ``eselect`` with no
arguments. Of course the foo-config style are still available (via symlinks)
if you prefer them.
-Guaranteed Support for ``$ROOT``
+Guaranteed support for ``$ROOT``
For those of you using $ROOT, you will not have to worry about whether a
particular tool can handle it. Support for ``$ROOT`` is required for all
eselect modules.
@@ -57,20 +57,20 @@
Writing your tool as an eselect module rather than starting from scratch gives
you various benefits:
-Faster Development time
+Faster development time
Much of the work has already been done for you. eselect provides a series
of libraries for common tasks, and the main ``eselect`` program handles
most of the hard work for you. All you need to do is provide the actions and
any domain specific functions you require.
-Automatic Actions
+Automatic actions
The ``help`` and ``usage`` actions are automatically generated from your
actions, so there is no need to spend time worrying about keeping these
written up to date.
-Easy, Consistent Behaviour
+Easy, consistent behaviour
Because most of the input, output and command line handling is split off
into library functions, writing a 'standard' module which behaves
consistently with other tools is very simple.
-Familiar Format
+Familiar format
For Gentoo developers, the eselect module format will be very familiar -- it
is a ``bash`` file with a structure that is quite similar to ebuilds.
@@ -85,7 +85,7 @@
eselect [<global-options>] <module> <action> <options>
eselect features consistently named actions among most of its modules. There
-is only one global option as of now; --no-color, which asks eselect to stop
+is only one global option as of now; --no-colour, which asks eselect to stop
showing colored output. The following are standard action names -- each module
may provide a subset of these actions:
^ permalink raw reply [flat|nested] only message in thread
only message in thread, other threads:[~2009-09-19 11:15 UTC | newest]
Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2009-09-19 11:15 [gentoo-commits] eselect r663 - trunk/doc Ulrich Mueller (ulm)
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox