public inbox for gentoo-commits@lists.gentoo.org
 help / color / mirror / Atom feed
* [gentoo-commits] proj/eselect:master commit in: /, doc/
@ 2013-04-06 11:21 Ulrich Mueller
  0 siblings, 0 replies; 8+ messages in thread
From: Ulrich Mueller @ 2013-04-06 11:21 UTC (permalink / raw
  To: gentoo-commits

commit:     a8495b99bbfde40b45e8262d16a41b369eba2d6c
Author:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Sat Apr  6 11:20:50 2013 +0000
Commit:     Ulrich Mueller <ulm <AT> gentoo <DOT> org>
CommitDate: Sat Apr  6 11:20:50 2013 +0000
URL:        http://git.overlays.gentoo.org/gitweb/?p=proj/eselect.git;a=commit;h=a8495b99

Document the "unset" action in developer guide.

* doc/developer-guide.txt: Document the "unset" action; it is used
by several external modules.

---
 ChangeLog               |    5 +++++
 doc/developer-guide.txt |    2 ++
 2 files changed, 7 insertions(+), 0 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index e6ee7e9..90c86c7 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2013-04-06  Ulrich Müller  <ulm@gentoo.org>
+
+	* doc/developer-guide.txt: Document the "unset" action; it is used
+	by several external modules.
+
 2013-02-22  Ulrich Müller  <ulm@gentoo.org>
 
 	* modules/profile.eselect (get_symlink_location):

diff --git a/doc/developer-guide.txt b/doc/developer-guide.txt
index 6ddc212..a24453a 100644
--- a/doc/developer-guide.txt
+++ b/doc/developer-guide.txt
@@ -189,6 +189,8 @@ list
     available modules.
 set
     Used to set a new provider or a symlink.
+unset
+    Used to unset the current provider, or to remove a symlink.
 enable
     Used to enable an optional feature.
 disable


^ permalink raw reply related	[flat|nested] 8+ messages in thread

* [gentoo-commits] proj/eselect:master commit in: /, doc/
@ 2013-07-09 21:08 Ulrich Mueller
  0 siblings, 0 replies; 8+ messages in thread
From: Ulrich Mueller @ 2013-07-09 21:08 UTC (permalink / raw
  To: gentoo-commits

commit:     65e152a4fa697b74ac7b7bf39bfd7fb6de876baa
Author:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Tue Jul  9 21:08:03 2013 +0000
Commit:     Ulrich Mueller <ulm <AT> gentoo <DOT> org>
CommitDate: Tue Jul  9 21:08:03 2013 +0000
URL:        http://git.overlays.gentoo.org/gitweb/?p=proj/eselect.git;a=commit;h=65e152a4

Update description of "arch" function in developer guide.

* doc/developer-guide.txt: Update description of the "arch"
function.

---
 ChangeLog               | 5 +++++
 doc/developer-guide.txt | 4 ++--
 2 files changed, 7 insertions(+), 2 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 38284d0..2d8c614 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2013-07-09  Ulrich Müller  <ulm@gentoo.org>
+
+	* doc/developer-guide.txt: Update description of the "arch"
+	function.
+
 2013-07-07  Ulrich Müller  <ulm@gentoo.org>
 
 	* libs/editor-variable.bash.in (do_set):

diff --git a/doc/developer-guide.txt b/doc/developer-guide.txt
index a24453a..9ecfdd9 100644
--- a/doc/developer-guide.txt
+++ b/doc/developer-guide.txt
@@ -486,8 +486,8 @@ The ``arch`` Function
 
 The ``arch`` function returns the correct value of ${ARCH} for the
 current system. If the package manager cannot provide this information,
-``arch`` falls back to a ``uname -m`` and ``uname -s`` based
-lookup-table.
+``arch`` falls back to a lookup-table based on the ``HOSTTYPE`` and
+``OSTYPE`` bash variables.
 
 The ``envvar`` Function
 ,,,,,,,,,,,,,,,,,,,,,,,


^ permalink raw reply related	[flat|nested] 8+ messages in thread

* [gentoo-commits] proj/eselect:master commit in: /, doc/
@ 2014-03-20 14:15 Ulrich Müller
  0 siblings, 0 replies; 8+ messages in thread
From: Ulrich Müller @ 2014-03-20 14:15 UTC (permalink / raw
  To: gentoo-commits

commit:     db7ee885d7d800d375220618f72b0a4b82a956ef
Author:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Thu Mar 20 14:21:34 2014 +0000
Commit:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Thu Mar 20 14:21:34 2014 +0000
URL:        http://git.overlays.gentoo.org/gitweb/?p=proj/eselect.git;a=commit;h=db7ee885

Remove duplicate heading in developer guide.

* doc/developer-guide.txt: Remove duplicate heading, because
rst2html --report=info complains about it.

---
 ChangeLog               | 3 +++
 doc/developer-guide.txt | 5 +----
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 9ae8fe6..1f666ec 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,8 @@
 2014-03-20  Ulrich Müller  <ulm@gentoo.org>
 
+	* doc/developer-guide.txt: Remove duplicate heading, because
+	rst2html --report=info complains about it.
+
 	* 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 e56f643..03b6846 100644
--- a/doc/developer-guide.txt
+++ b/doc/developer-guide.txt
@@ -2,11 +2,8 @@
 eselect Developer Reference
 ===========================
 
-Introduction
-============
-
 About eselect
--------------
+=============
 
 eselect is a framework for simplifying and introducing consistency to
 the various Gentoo ``foo-config`` and ``update-blah`` tools. It is an


^ permalink raw reply related	[flat|nested] 8+ messages in thread

* [gentoo-commits] proj/eselect:master commit in: /, doc/
@ 2014-03-20 18:33 Ulrich Müller
  0 siblings, 0 replies; 8+ messages in thread
From: Ulrich Müller @ 2014-03-20 18:33 UTC (permalink / raw
  To: gentoo-commits

commit:     66c4b410b6a45c1c3fd4d2acc9edf77b339143ce
Author:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Thu Mar 20 18:35:25 2014 +0000
Commit:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Thu Mar 20 18:35:25 2014 +0000
URL:        http://git.overlays.gentoo.org/gitweb/?p=proj/eselect.git;a=commit;h=66c4b410

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.

---
 ChangeLog               |  4 ++++
 doc/developer-guide.txt | 16 ++++++++--------
 doc/user-guide.txt      |  8 +++++---
 3 files changed, 17 insertions(+), 11 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 1f666ec..94f37dc 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -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.


^ permalink raw reply related	[flat|nested] 8+ messages in thread

* [gentoo-commits] proj/eselect:master commit in: /, doc/
@ 2014-03-20 18:49 Ulrich Müller
  0 siblings, 0 replies; 8+ messages in thread
From: Ulrich Müller @ 2014-03-20 18:49 UTC (permalink / raw
  To: gentoo-commits

commit:     15532aca7c2a3a452d4822da83c1baf368266ead
Author:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Thu Mar 20 18:55:07 2014 +0000
Commit:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Thu Mar 20 18:55:07 2014 +0000
URL:        http://git.overlays.gentoo.org/gitweb/?p=proj/eselect.git;a=commit;h=15532aca

Remove redundant heading in user guide.

* doc/user-guide.txt: Remove redundant "Usage" heading.

---
 ChangeLog          | 1 +
 doc/user-guide.txt | 3 ---
 2 files changed, 1 insertion(+), 3 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 94f37dc..143edc8 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,6 +1,7 @@
 2014-03-20  Ulrich Müller  <ulm@gentoo.org>
 
 	* doc/user-guide.txt: Mention the "unset" action also here.
+	Remove redundant "Usage" heading.
 
 	* doc/developer-guide.txt: Remove duplicate heading, because
 	rst2html --report=info complains about it.

diff --git a/doc/user-guide.txt b/doc/user-guide.txt
index 7784d20..6960c30 100644
--- a/doc/user-guide.txt
+++ b/doc/user-guide.txt
@@ -86,9 +86,6 @@ Familiar format
 Using eselect
 =============
 
-Usage
------
-
 eselect should be called as shown below: ::
 
         eselect [<global-options>] <module> <action> <options>


^ permalink raw reply related	[flat|nested] 8+ messages in thread

* [gentoo-commits] proj/eselect:master commit in: /, doc/
@ 2015-08-26  7:41 Ulrich Müller
  0 siblings, 0 replies; 8+ messages in thread
From: Ulrich Müller @ 2015-08-26  7:41 UTC (permalink / raw
  To: gentoo-commits

commit:     1d2b0dece81ad2bf9ed7d37982e291060fbe93dc
Author:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Wed Aug 26 07:39:45 2015 +0000
Commit:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Wed Aug 26 07:39:45 2015 +0000
URL:        https://gitweb.gentoo.org/proj/eselect.git/commit/?id=1d2b0dec

Use sentence case in documentation.

* doc/developer-guide.txt:
* doc/user-guide.txt:
* doc/release-guide.txt: Use sentence case in headings.

 ChangeLog               |   6 +++
 doc/developer-guide.txt | 106 ++++++++++++++++++++++++------------------------
 doc/release-guide.txt   |   2 +-
 doc/user-guide.txt      |   8 ++--
 4 files changed, 64 insertions(+), 58 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index da5fefd..ac3b25a 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2015-08-26  Ulrich Müller  <ulm@gentoo.org>
+
+	* doc/developer-guide.txt:
+	* doc/user-guide.txt:
+	* doc/release-guide.txt: Use sentence case in headings.
+
 2015-08-22  Ulrich Müller  <ulm@gentoo.org>
 
 	* configure.ac (EXTRAVERSION): Fix detection of git revision

diff --git a/doc/developer-guide.txt b/doc/developer-guide.txt
index 474437d..ddef9f7 100644
--- a/doc/developer-guide.txt
+++ b/doc/developer-guide.txt
@@ -1,5 +1,5 @@
 ===========================
-eselect Developer Reference
+eselect developer reference
 ===========================
 
 About eselect
@@ -10,7 +10,7 @@ the various Gentoo ``foo-config`` and ``update-blah`` tools. It is an
 option for developers who don't like reinventing the wheel, not a
 mandatory tool.
 
-Getting Started
+Getting started
 ===============
 
 Introduction
@@ -22,7 +22,7 @@ an existing module, so check to see whether there is something that does
 almost what you need first (symlink handling is a good example of
 something that can be copied rather than reinvented).
 
-A Simple Module
+A simple module
 ---------------
 
 It's easiest to illustrate by example. Here's a simplified version of
@@ -164,7 +164,7 @@ All modules contributed to eselect should have a header indicating
 copyright. This must be an exact copy of the header in the above
 example (except for the years, of course).
 
-Standard Action Names
+Standard action names
 ---------------------
 
 The following list contains suggested allowed names for actions.
@@ -205,7 +205,7 @@ scan
   You should only do this with a good reason. Removing them is not
   a good idea, ``eselect`` assumes that they exist.
 
-Utility Functions
+Utility functions
 =================
 
 eselect provides many utility functions. These are useful for
@@ -215,24 +215,24 @@ output format required, consider implementing one.
 
 The following categories of function are available by default:
 
-* General Utility Functions
-* Output Utility Functions
-* Test Functions
-* Path-Manipulation Functions
-* Manipulation Functions
-* Configuration Functions
-* Multilib Functions
-* Package-Manager Functions
+* General utility functions
+* Output utility functions
+* Test functions
+* Path-manipulation functions
+* Manipulation functions
+* Configuration functions
+* Multilib functions
+* Package-Manager functions
 
 To use any of the other functions, you have first to ``inherit`` the
-corresponding library file. (cf: `The inherit Function`_)
+corresponding library file. (cf: `The inherit function`_)
 
-General Utility Functions
+General utility functions
 -------------------------
 
 These are implemented in ``libs/core.bash``.
 
-The ``die`` Function
+The ``die`` function
 ,,,,,,,,,,,,,,,,,,,,
 
 The ``die`` function (which, unlike its ebuild counterpart, *can* be
@@ -241,7 +241,7 @@ should be invoked as ``die -q "Message to display"``. If the ``-q`` is
 not provided, a stacktrace will be displayed -- this should never happen
 because of user input error, only abnormal conditions.
 
-The ``check_do`` Function
+The ``check_do`` function
 ,,,,,,,,,,,,,,,,,,,,,,,,,
 
 The ``check_do`` utility function checks that the first parameter is
@@ -249,43 +249,43 @@ a function, and then calls it with any additional parameters as its
 arguments. If the function does not exist, ``die`` is called. Again,
 this is mostly internal.
 
-The ``do_action`` Function
+The ``do_action`` function
 ,,,,,,,,,,,,,,,,,,,,,,,,,,
 
 The ``do_action`` utility function is the correct way to call a utility
 function which is defined in another module. The first parameter is the
 action, additional parameters are passed as arguments.
 
-The ``inherit`` Function
+The ``inherit`` function
 ,,,,,,,,,,,,,,,,,,,,,,,,
 
 The ``inherit`` function sources eselect library files based on their
 name. In order to source the file ``libs/foo.bash`` you have to add
 ``inherit foo`` in global scope of your module.
 
-The ``sed`` Function
+The ``sed`` function
 ,,,,,,,,,,,,,,,,,,,,
 
 The ``sed`` function is a wrapper around GNU ``sed``.
 
-Output Utility Functions
+Output utility functions
 ------------------------
 
 These are implemented in ``libs/output.bash``.
 
-The ``write_error_msg`` Function
+The ``write_error_msg`` function
 ,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
 
 The ``write_error_msg`` function displays an error message in the
 standard format. It is similar to ``eerror``.
 
-The ``write_warning_msg`` Function
+The ``write_warning_msg`` function
 ,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
 
 The ``write_warning_msg`` function displays a warning message in the
 standard format. It is similar to ``ewarn``.
 
-The ``write_list_`` Functions
+The ``write_list_`` functions
 ,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
 
 To display a list, the ``write_list_`` family of functions should be
@@ -309,7 +309,7 @@ list.
 If ``-p`` is passed as the first argument to these functions, 'plain'
 highlighting is used.
 
-The ``highlight`` Function
+The ``highlight`` function
 ,,,,,,,,,,,,,,,,,,,,,,,,,,
 
 The ``highlight`` utility function can be used to emphasise some text
@@ -322,13 +322,13 @@ invocation might look like: ::
         "$(highlight Second)" "This is the $(highlight second) entry"
     write_kv_list_entry "Third" "$(highlight The end)"
 
-The ``highlight_warning`` Function
+The ``highlight_warning`` function
 ,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
 
 The ``highlight_warning`` function is like ``highlight``, but for
 warnings. It displays the text in question in red.
 
-The ``highlight_marker`` Function
+The ``highlight_marker`` function
 ,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
 
 To mark a list entry as active/selected, the ``highlight_marker``
@@ -341,7 +341,7 @@ behind the entry. A typical invocation might look like: ::
             && targets[i]=$(highlight_marker "${targets[i]}")
     done
 
-The ``is_output_mode`` Function
+The ``is_output_mode`` function
 ,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
 
 The ``is_output_mode`` function returns true if and only if its
@@ -349,72 +349,72 @@ parameter is equal to eselect's output mode. Currently, only the default
 and ``brief`` output modes are defined, the latter corresponding to the
 ``--brief`` option.
 
-The ``space`` Function
+The ``space`` function
 ,,,,,,,,,,,,,,,,,,,,,,
 
 The ``space`` utility function takes a single integer parameter.
 It displays that many space characters.
 
-Test Functions
+Test functions
 --------------
 
 These are implemented in ``libs/tests.bash``.
 
-The ``has`` Function
+The ``has`` function
 ,,,,,,,,,,,,,,,,,,,,
 
 The ``has`` utility function is like Portage's ``hasq``. It returns true
 if and only if the first parameter is equal to any of the remaining
 parameters.
 
-The ``is_function`` Function
+The ``is_function`` function
 ,,,,,,,,,,,,,,,,,,,,,,,,,,,,
 
 The ``is_function`` utility function returns true if and only if its
 parameter exists and is a function. This is mostly used internally, but
 may have some use for modules.
 
-The ``is_number`` Function
+The ``is_number`` function
 ,,,,,,,,,,,,,,,,,,,,,,,,,,
 
 Returns true if and only if the parameter is a positive whole number.
 
-Path-Manipulation Functions
+Path-manipulation functions
 ---------------------------
 
 These are implemented in ``libs/path-manipulation``.
 
-The ``basename`` Function
+The ``basename`` function
 ,,,,,,,,,,,,,,,,,,,,,,,,,
 
 The ``basename`` function is a transparent bash-only replacement for the
 external ``basename`` application.
 
-The ``dirname`` Function
+The ``dirname`` function
 ,,,,,,,,,,,,,,,,,,,,,,,,
 
 The ``dirname`` function is a transparent bash-only replacement for the
 external ``dirname`` application.
 
-The ``canonicalise`` Function
+The ``canonicalise`` function
 ,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
 
 The ``canonicalise`` function is a wrapper to either GNU ``readlink -f``
 or ``realpath``.
 
-The ``relative_name`` Function
+The ``relative_name`` function
 ,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
 
 The ``relative_name`` function converts a path name (passed as its first
 argument) to be relative to a directory (second argument). This can be
 used to generate a relative symlink from absolute paths.
 
-Manipulation Functions
+Manipulation functions
 ----------------------
 
 These are implemented in ``libs/manip.bash``.
 
-The ``svn_date_to_version`` Function
+The ``svn_date_to_version`` function
 ,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
 
 If your module is kept in a CVS or subversion repository, then the
@@ -429,12 +429,12 @@ Then turn on SVN keyword expansion for the module: ::
 
     svn propset svn:keywords "Date" modules/foo.eselect
 
-Configuration Functions
+Configuration functions
 -----------------------
 
 These are implemented in ``libs/config.bash``.
 
-The ``store_config`` Function
+The ``store_config`` function
 ,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
 
 The ``store_config`` function saves a key/value pair in a given
@@ -444,14 +444,14 @@ altered manually. Comments in the file will be deleted each time
 ``store_config`` is called. The function is invoked as
 ``store_config filename key value``.
 
-The ``load_config`` Function
+The ``load_config`` function
 ,,,,,,,,,,,,,,,,,,,,,,,,,,,,
 
 The ``load_config`` function loads a stored value from the module's
 configuration file. It is invoked as ``load_config filename key``
 and prints the associated value.
 
-The ``append_config`` Function
+The ``append_config`` function
 ,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
 
 The ``append_config`` function appends an item to an already stored
@@ -460,12 +460,12 @@ value in the module's configuration file. It uses ``load_config`` /
 ``append_config filename key item``. Note that the item will not be
 appended if it occurs in the key's value already.
 
-Multilib Functions
+Multilib functions
 ------------------
 
 These are implemented in ``libs/multilib.bash``.
 
-The ``list_libdirs`` Function
+The ``list_libdirs`` function
 ,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
 
 The ``list_libdirs`` function returns a set of valid libdirs for the
@@ -473,12 +473,12 @@ used architecture. By default it uses /etc/ld.so.conf to obtain all
 valid libdirs. If this fails due to a missing or broken file, this
 function uses ``uname`` to determine the architecture.
 
-Package-Manager Functions
+Package-manager functions
 -------------------------
 
 These are implemented in ``libs/package-manager.bash``.
 
-The ``arch`` Function
+The ``arch`` function
 ,,,,,,,,,,,,,,,,,,,,,
 
 The ``arch`` function returns the correct value of the ``ARCH`` variable
@@ -486,32 +486,32 @@ for the current system. If the package manager cannot provide this
 information, ``arch`` falls back to a lookup-table based on the
 ``HOSTTYPE`` and ``OSTYPE`` bash variables.
 
-The ``envvar`` Function
+The ``envvar`` function
 ,,,,,,,,,,,,,,,,,,,,,,,
 
 The ``envvar`` function retrieves the contents of a
 configuration-environment variable for a given package. The syntax is
 ``envvar ${package-name} ${var-name}``.
 
-The ``best_version`` Function
+The ``best_version`` function
 ,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
 
 The ``best_version`` function returns the highest available version for
 a given package dep atom.
 
-The ``has_version`` Function
+The ``has_version`` function
 ,,,,,,,,,,,,,,,,,,,,,,,,,,,,
 
 The ``has_version`` function checks whether a given versioned package
 dep atom is installed.
 
-The ``get_repositories`` Function
+The ``get_repositories`` function
 ,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
 
 The ``get_repositories`` function returns a list of repositories known
 to the package manager.
 
-The ``get_repo_news_dir`` Function
+The ``get_repo_news_dir`` function
 ,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
 
 The ``get_repo_news_dir`` function returns the directory where to find

diff --git a/doc/release-guide.txt b/doc/release-guide.txt
index 05be1d5..3e23b13 100644
--- a/doc/release-guide.txt
+++ b/doc/release-guide.txt
@@ -1,4 +1,4 @@
-eselect Release Guide
+eselect release guide
 =====================
 
 .. Note:: This guide is intended for people who do ``eselect`` releases.

diff --git a/doc/user-guide.txt b/doc/user-guide.txt
index 686757d..8ec35c4 100644
--- a/doc/user-guide.txt
+++ b/doc/user-guide.txt
@@ -1,8 +1,8 @@
 ==================
-eselect User Guide
+eselect user guide
 ==================
 
-A Brief Overview
+A brief overview
 ================
 
 Introduction
@@ -28,7 +28,7 @@ Some modules install symlinks to the main program. eselect handles these
 intelligently -- for example, it realises that ``profile-config list``
 should be treated as if the user had run ``eselect profile list``.
 
-Advantages for End Users and System Administrators
+Advantages for end users and system administrators
 --------------------------------------------------
 
 For system administrators and end users, tools written as eselect
@@ -56,7 +56,7 @@ Guaranteed support for ``$ROOT``
     whether a particular tool can handle it. Support for ``$ROOT`` is
     required for all eselect modules.
 
-Advantages for Developers and Package Maintainers
+Advantages for developers and package maintainers
 -------------------------------------------------
 
 Writing your tool as an eselect module rather than starting from scratch


^ permalink raw reply related	[flat|nested] 8+ messages in thread

* [gentoo-commits] proj/eselect:master commit in: /, doc/
@ 2023-08-22  9:44 Ulrich Müller
  0 siblings, 0 replies; 8+ messages in thread
From: Ulrich Müller @ 2023-08-22  9:44 UTC (permalink / raw
  To: gentoo-commits

commit:     31feb189bf0b4610bc1b04f7b6e18f0fd827533c
Author:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Tue Aug 22 09:42:01 2023 +0000
Commit:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Tue Aug 22 09:42:01 2023 +0000
URL:        https://gitweb.gentoo.org/proj/eselect.git/commit/?id=31feb189

Update documentation for "has"

* doc/developer-guide.txt: Update documentation for "has".

Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>

 ChangeLog               | 4 ++++
 doc/developer-guide.txt | 4 ++--
 2 files changed, 6 insertions(+), 2 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index cce6fb2..e534492 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2023-08-22  Ulrich Müller  <ulm@gentoo.org>
+
+	* doc/developer-guide.txt: Update documentation for "has".
+
 2023-08-09  Ulrich Müller  <ulm@gentoo.org>
 
 	* configure.ac: Update version to 1.4.26.

diff --git a/doc/developer-guide.txt b/doc/developer-guide.txt
index 16393cb..50f8bdd 100644
--- a/doc/developer-guide.txt
+++ b/doc/developer-guide.txt
@@ -371,8 +371,8 @@ These are implemented in ``libs/tests.bash``.
 The ``has`` function
 ,,,,,,,,,,,,,,,,,,,,
 
-The ``has`` utility function is like Portage's ``hasq``. It returns true
-if and only if the first parameter is equal to any of the remaining
+The ``has`` utility function is like its Portage equivalent. It returns
+true if and only if the first parameter is equal to any of the remaining
 parameters.
 
 The ``is_function`` function


^ permalink raw reply related	[flat|nested] 8+ messages in thread

* [gentoo-commits] proj/eselect:master commit in: /, doc/
@ 2023-08-22 10:41 Ulrich Müller
  0 siblings, 0 replies; 8+ messages in thread
From: Ulrich Müller @ 2023-08-22 10:41 UTC (permalink / raw
  To: gentoo-commits

commit:     91eda5f425a87a067dd07e0f9a71c288bd3350d5
Author:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Tue Aug 22 09:42:01 2023 +0000
Commit:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Tue Aug 22 09:42:01 2023 +0000
URL:        https://gitweb.gentoo.org/proj/eselect.git/commit/?id=91eda5f4

Update documentation for "has"

* doc/developer-guide.txt: Update documentation for "has".

Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>

 ChangeLog               | 4 ++++
 doc/developer-guide.txt | 4 ++--
 2 files changed, 6 insertions(+), 2 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index cce6fb2..e534492 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2023-08-22  Ulrich Müller  <ulm@gentoo.org>
+
+	* doc/developer-guide.txt: Update documentation for "has".
+
 2023-08-09  Ulrich Müller  <ulm@gentoo.org>
 
 	* configure.ac: Update version to 1.4.26.

diff --git a/doc/developer-guide.txt b/doc/developer-guide.txt
index 16393cb..50f8bdd 100644
--- a/doc/developer-guide.txt
+++ b/doc/developer-guide.txt
@@ -371,8 +371,8 @@ These are implemented in ``libs/tests.bash``.
 The ``has`` function
 ,,,,,,,,,,,,,,,,,,,,
 
-The ``has`` utility function is like Portage's ``hasq``. It returns true
-if and only if the first parameter is equal to any of the remaining
+The ``has`` utility function is like its Portage equivalent. It returns
+true if and only if the first parameter is equal to any of the remaining
 parameters.
 
 The ``is_function`` function


^ permalink raw reply related	[flat|nested] 8+ messages in thread

end of thread, other threads:[~2023-08-22 10:41 UTC | newest]

Thread overview: 8+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2014-03-20 18:33 [gentoo-commits] proj/eselect:master commit in: /, doc/ Ulrich Müller
  -- strict thread matches above, loose matches on Subject: below --
2023-08-22 10:41 Ulrich Müller
2023-08-22  9:44 Ulrich Müller
2015-08-26  7:41 Ulrich Müller
2014-03-20 18:49 Ulrich Müller
2014-03-20 14:15 Ulrich Müller
2013-07-09 21:08 Ulrich Mueller
2013-04-06 11:21 Ulrich Mueller

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox