[gentoo-commits] proj/eselect:master commit in: /, doc/
commit: 91eda5f425a87a067dd07e0f9a71c288bd3350d5 Author: Ulrich Müller gentoo org> AuthorDate: Tue Aug 22 09:42:01 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Tue Aug 22 09:42:01 2023 + 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 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 + + * doc/developer-guide.txt: Update documentation for "has". + 2023-08-09 Ulrich Müller * 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
[gentoo-commits] proj/eselect:master commit in: /, doc/
commit: 31feb189bf0b4610bc1b04f7b6e18f0fd827533c Author: Ulrich Müller gentoo org> AuthorDate: Tue Aug 22 09:42:01 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Tue Aug 22 09:42:01 2023 + 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 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 + + * doc/developer-guide.txt: Update documentation for "has". + 2023-08-09 Ulrich Müller * 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
[gentoo-commits] proj/eselect:master commit in: doc/, /
commit: 5f3a0c3cbf4c85b69a3937b792a37ae8d95d6b8a Author: Ulrich Müller gentoo org> AuthorDate: Sun Jun 4 17:35:26 2023 + Commit: Ulrich Müller gentoo org> CommitDate: Sun Jun 4 17:35:26 2023 + URL:https://gitweb.gentoo.org/proj/eselect.git/commit/?id=5f3a0c3c Add subsection about module testing to developer guide * doc/developer-guide.txt: Add subsection about module testing. Thanks to torsi fi.uba.ar for the suggestion. Bug 907844. Original-author: Lemon Lime fi.uba.ar> Closes: https://bugs.gentoo.org/907844 Signed-off-by: Ulrich Müller gentoo.org> ChangeLog | 5 + doc/developer-guide.txt | 8 2 files changed, 13 insertions(+) diff --git a/ChangeLog b/ChangeLog index ce13578..afa6885 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +2023-06-04 Ulrich Müller + + * doc/developer-guide.txt: Add subsection about module testing. + Thanks to to...@fi.uba.ar for the suggestion. Bug 907844. + 2023-05-11 Ulrich Müller * bin/eselect.in: Update shebang to use EPREFIX. Bug 905934. diff --git a/doc/developer-guide.txt b/doc/developer-guide.txt index 694b64d..16393cb 100644 --- a/doc/developer-guide.txt +++ b/doc/developer-guide.txt @@ -164,6 +164,14 @@ 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). +Adding modules for testing +-- + +eselect modules can be manually added to the system. This is specially +useful when an eselect module is being developed and needs testing. +Copying (or symlinking) the eselect module to ``~/.eselect/modules/`` +will make eselect aware of it. + Standard action names -
[gentoo-commits] proj/eselect:master commit in: doc/, man/, misc/, /, modules/, libs/, bin/
commit: 14b42c332c33eb0a40658bdc51552e1021692291
Author: Ulrich Müller gentoo org>
AuthorDate: Wed Feb 13 20:50:31 2019 +
Commit: Ulrich Müller gentoo org>
CommitDate: Wed Feb 13 20:50:31 2019 +
URL:https://gitweb.gentoo.org/proj/eselect.git/commit/?id=14b42c33
Update copyright years.
Signed-off-by: Ulrich Müller gentoo.org>
README | 2 +-
bin/eselect.in | 4 ++--
doc/developer-guide.txt| 2 +-
libs/config.bash.in| 2 +-
libs/core.bash.in | 2 +-
libs/default.eselect.in| 2 +-
libs/editor-variable.bash.in | 2 +-
libs/manip.bash.in | 2 +-
libs/multilib.bash.in | 2 +-
libs/output.bash.in| 2 +-
libs/package-manager.bash.in | 2 +-
libs/path-manipulation.bash.in | 2 +-
libs/skel.bash.in | 2 +-
libs/tests.bash.in | 2 +-
man/editor.eselect.5 | 2 +-
man/env.eselect.5 | 2 +-
man/eselect.1 | 2 +-
man/kernel.eselect.5 | 2 +-
man/news.eselect.5 | 2 +-
man/pager.eselect.5| 2 +-
man/profile.eselect.5 | 2 +-
man/rc.eselect.5 | 2 +-
man/visual.eselect.5 | 2 +-
misc/eselect-mode.el | 2 +-
misc/eselect.bashcomp | 2 +-
modules/config.eselect | 2 +-
modules/cow.eselect| 2 +-
modules/editor.eselect | 2 +-
modules/env.eselect| 2 +-
modules/kernel.eselect | 2 +-
modules/locale.eselect | 2 +-
modules/modules.eselect| 2 +-
modules/news.eselect | 2 +-
modules/pager.eselect | 2 +-
modules/profile.eselect| 2 +-
modules/rc.eselect | 2 +-
modules/visual.eselect | 2 +-
37 files changed, 38 insertions(+), 38 deletions(-)
diff --git a/README b/README
index b063481..1ef30e6 100644
--- a/README
+++ b/README
@@ -14,7 +14,7 @@ See ``doc/``. Use ``make html`` for HTML versions.
Copyright
-
-eselect is Copyright (c) 2005-2018 Gentoo Authors. This code is
+eselect is Copyright (c) 2005-2019 Gentoo Authors. This code is
distributed under the terms of the `GNU General Public License,
version 2 or later`__.
diff --git a/bin/eselect.in b/bin/eselect.in
index fc8785b..f9d4d0b 100755
--- a/bin/eselect.in
+++ b/bin/eselect.in
@@ -1,6 +1,6 @@
#!@BASH@
# -*-eselect-*- vim: ft=eselect
-# Copyright (c) 2005-2018 Gentoo Authors
+# Copyright (c) 2005-2019 Gentoo Authors
#
# This file is part of the 'eselect' tools framework.
#
@@ -98,7 +98,7 @@ es_do_help() {
es_do_version() {
echo "eselect ${ESELECT_VERSION}"
echo
- echo "Copyright (c) 2005-2018 Gentoo Authors."
+ echo "Copyright (c) 2005-2019 Gentoo Authors."
echo "Distributed under the terms of the GNU GPL version 2 or later."
}
diff --git a/doc/developer-guide.txt b/doc/developer-guide.txt
index abeccc2..ffe095c 100644
--- a/doc/developer-guide.txt
+++ b/doc/developer-guide.txt
@@ -31,7 +31,7 @@ and ``set``, plus the standard ``help``, ``usage``, and
``version``
actions, and is installed to ``$(datadir)/eselect/modules/`` ::
# -*-eselect-*- vim: ft=eselect
-# Copyright 2005-2018 Gentoo Authors
+# Copyright 2005-2019 Gentoo Authors
# Distributed under the terms of the GNU GPL version 2 or later
DESCRIPTION="Manage the /usr/src/linux symlink"
diff --git a/libs/config.bash.in b/libs/config.bash.in
index 37858a1..78d2d75 100644
--- a/libs/config.bash.in
+++ b/libs/config.bash.in
@@ -1,5 +1,5 @@
# -*-eselect-*- vim: ft=eselect
-# Copyright (c) 2005-2018 Gentoo Authors
+# Copyright (c) 2005-2019 Gentoo Authors
#
# This file is part of the 'eselect' tools framework.
#
diff --git a/libs/core.bash.in b/libs/core.bash.in
index 44171d1..46c08bd 100644
--- a/libs/core.bash.in
+++ b/libs/core.bash.in
@@ -1,5 +1,5 @@
# -*-eselect-*- vim: ft=eselect
-# Copyright (c) 2005-2018 Gentoo Authors
+# Copyright (c) 2005-2019 Gentoo Authors
#
# This file is part of the 'eselect' tools framework.
#
diff --git a/libs/default.eselect.in b/libs/default.eselect.in
index 07601ad..8c34ef4 100644
--- a/libs/default.eselect.in
+++ b/libs/default.eselect.in
@@ -1,5 +1,5 @@
# -*-eselect-*- vim: ft=eselect
-# Copyright (c) 2005-2018 Gentoo Authors
+# Copyright (c) 2005-2019 Gentoo Authors
#
# This file is part of the 'eselect' tools framework.
#
diff --git a/libs/editor-variable.bash.in b/libs/editor-variable.bash.in
index 12c9418..ac71ecf 100644
--- a/libs/editor-variable.bash.in
+++ b/libs/editor-variable.bash.in
@@ -1,5 +1,5 @@
# -*-eselect-*- vim: ft=eselect
-# Copyright (c) 2005-2018 Gentoo Authors
+# Copyright (c) 2005-2019 Gentoo Authors
#
# This file is part of the 'eselect' tools framework.
#
diff --git a/libs/manip.bash.in b/libs/manip.bash.in
index 16f2671..2c16001 100644
--- a/libs/manip.bash.in
+++ b/libs/manip.bash.in
@@ -1,5 +1,5 @@
# -*-eselect-*- vim: ft=eselect
[gentoo-commits] proj/eselect:master commit in: doc/, libs/, /, modules/, man/, misc/, bin/
commit: 8c36a771d720a7a86662ab7bf431cb86cd9874e5
Author: Ulrich Müller gentoo org>
AuthorDate: Sun Sep 16 14:25:59 2018 +
Commit: Ulrich Müller gentoo org>
CommitDate: Sun Sep 16 14:25:59 2018 +
URL:https://gitweb.gentoo.org/proj/eselect.git/commit/?id=8c36a771
Update copyright notices to follow the new policy.
README | 2 +-
bin/eselect.in | 4 ++--
doc/developer-guide.txt| 4 ++--
libs/config.bash.in| 2 +-
libs/core.bash.in | 2 +-
libs/default.eselect.in| 2 +-
libs/editor-variable.bash.in | 2 +-
libs/manip.bash.in | 2 +-
libs/multilib.bash.in | 2 +-
libs/output.bash.in| 2 +-
libs/package-manager.bash.in | 2 +-
libs/path-manipulation.bash.in | 2 +-
libs/skel.bash.in | 2 +-
libs/tests.bash.in | 2 +-
man/editor.eselect.5 | 2 +-
man/env.eselect.5 | 2 +-
man/eselect.1 | 2 +-
man/kernel.eselect.5 | 2 +-
man/news.eselect.5 | 2 +-
man/pager.eselect.5| 2 +-
man/profile.eselect.5 | 2 +-
man/rc.eselect.5 | 2 +-
man/visual.eselect.5 | 2 +-
misc/eselect-mode.el | 5 -
misc/eselect.bashcomp | 2 +-
modules/config.eselect | 2 +-
modules/cow.eselect| 2 +-
modules/editor.eselect | 2 +-
modules/env.eselect| 2 +-
modules/kernel.eselect | 2 +-
modules/locale.eselect | 2 +-
modules/modules.eselect| 2 +-
modules/news.eselect | 2 +-
modules/pager.eselect | 2 +-
modules/profile.eselect| 2 +-
modules/rc.eselect | 2 +-
modules/visual.eselect | 2 +-
37 files changed, 42 insertions(+), 39 deletions(-)
diff --git a/README b/README
index 57498d3..b063481 100644
--- a/README
+++ b/README
@@ -14,7 +14,7 @@ See ``doc/``. Use ``make html`` for HTML versions.
Copyright
-
-eselect is Copyright (c) 2005-2018 Gentoo Foundation. This code is
+eselect is Copyright (c) 2005-2018 Gentoo Authors. This code is
distributed under the terms of the `GNU General Public License,
version 2 or later`__.
diff --git a/bin/eselect.in b/bin/eselect.in
index 432f4e8..fc8785b 100755
--- a/bin/eselect.in
+++ b/bin/eselect.in
@@ -1,6 +1,6 @@
#!@BASH@
# -*-eselect-*- vim: ft=eselect
-# Copyright (c) 2005-2018 Gentoo Foundation
+# Copyright (c) 2005-2018 Gentoo Authors
#
# This file is part of the 'eselect' tools framework.
#
@@ -98,7 +98,7 @@ es_do_help() {
es_do_version() {
echo "eselect ${ESELECT_VERSION}"
echo
- echo "Copyright (c) 2005-2018 Gentoo Foundation."
+ echo "Copyright (c) 2005-2018 Gentoo Authors."
echo "Distributed under the terms of the GNU GPL version 2 or later."
}
diff --git a/doc/developer-guide.txt b/doc/developer-guide.txt
index 076c5ca..abeccc2 100644
--- a/doc/developer-guide.txt
+++ b/doc/developer-guide.txt
@@ -31,12 +31,12 @@ and ``set``, plus the standard ``help``, ``usage``, and
``version``
actions, and is installed to ``$(datadir)/eselect/modules/`` ::
# -*-eselect-*- vim: ft=eselect
-# Copyright 2005-2012 Gentoo Foundation
+# Copyright 2005-2018 Gentoo Authors
# Distributed under the terms of the GNU GPL version 2 or later
DESCRIPTION="Manage the /usr/src/linux symlink"
MAINTAINER="esel...@gentoo.org"
-VERSION="20120307"
+VERSION="20180916"
# find a list of kernel symlink targets
find_targets() {
diff --git a/libs/config.bash.in b/libs/config.bash.in
index 33a2695..37858a1 100644
--- a/libs/config.bash.in
+++ b/libs/config.bash.in
@@ -1,5 +1,5 @@
# -*-eselect-*- vim: ft=eselect
-# Copyright (c) 2005-2018 Gentoo Foundation
+# Copyright (c) 2005-2018 Gentoo Authors
#
# This file is part of the 'eselect' tools framework.
#
diff --git a/libs/core.bash.in b/libs/core.bash.in
index 6f77626..44171d1 100644
--- a/libs/core.bash.in
+++ b/libs/core.bash.in
@@ -1,5 +1,5 @@
# -*-eselect-*- vim: ft=eselect
-# Copyright (c) 2005-2018 Gentoo Foundation
+# Copyright (c) 2005-2018 Gentoo Authors
#
# This file is part of the 'eselect' tools framework.
#
diff --git a/libs/default.eselect.in b/libs/default.eselect.in
index b889f95..07601ad 100644
--- a/libs/default.eselect.in
+++ b/libs/default.eselect.in
@@ -1,5 +1,5 @@
# -*-eselect-*- vim: ft=eselect
-# Copyright (c) 2005-2018 Gentoo Foundation
+# Copyright (c) 2005-2018 Gentoo Authors
#
# This file is part of the 'eselect' tools framework.
#
diff --git a/libs/editor-variable.bash.in b/libs/editor-variable.bash.in
index 61bd981..12c9418 100644
--- a/libs/editor-variable.bash.in
+++ b/libs/editor-variable.bash.in
@@ -1,5 +1,5 @@
# -*-eselect-*- vim: ft=eselect
-# Copyright (c) 2005-2018 Gentoo Foundation
+# Copyright (c) 2005-2018 Gentoo Authors
#
# This file is part of the 'eselect' tools framework.
#
diff --git
[gentoo-commits] proj/eselect:master commit in: doc/, misc/, /, libs/
commit: cd03bb12fa2799c76987346f6834b78fda9285a7
Author: Ulrich Müller gentoo org>
AuthorDate: Tue May 29 16:33:42 2018 +
Commit: Ulrich Müller gentoo org>
CommitDate: Tue May 29 16:33:42 2018 +
URL:https://gitweb.gentoo.org/proj/eselect.git/commit/?id=cd03bb12
New get_libdir function.
* libs/multilib.bash.in (get_libdir): New function.
* doc/developer-guide.txt: Describe it.
* libs/Makefile.am (dosed): Substitute @libdir@.
* misc/eselect-mode.el (eselect-mode-keywords-multilib):
Add get_libdir.
ChangeLog | 8
doc/developer-guide.txt | 6 ++
libs/Makefile.am| 3 ++-
libs/multilib.bash.in | 7 +++
misc/eselect-mode.el| 2 +-
5 files changed, 24 insertions(+), 2 deletions(-)
diff --git a/ChangeLog b/ChangeLog
index d94fe63..4f6510e 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,11 @@
+2018-05-29 Ulrich Müller
+
+ * libs/multilib.bash.in (get_libdir): New function.
+ * doc/developer-guide.txt: Describe it.
+ * libs/Makefile.am (dosed): Substitute @libdir@.
+ * misc/eselect-mode.el (eselect-mode-keywords-multilib):
+ Add get_libdir.
+
2018-01-24 Ulrich Müller
* configure.ac: Update version to 1.4.12.
diff --git a/doc/developer-guide.txt b/doc/developer-guide.txt
index ddef9f7..408b2a7 100644
--- a/doc/developer-guide.txt
+++ b/doc/developer-guide.txt
@@ -473,6 +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.
+The ``get_libdir`` function
+,,,
+
+The ``get_libdir`` function prints the basename of the libdir path that
+was passed to eselect's configure.
+
Package-manager functions
-
diff --git a/libs/Makefile.am b/libs/Makefile.am
index 027ef73..6ebd08e 100644
--- a/libs/Makefile.am
+++ b/libs/Makefile.am
@@ -30,7 +30,8 @@ dosed = @SED@ \
-e 's%\@SED\@%@SED@%g' \
-e 's%\@PORTAGEQ\@%@PORTAGEQ@%g' \
-e 's%\@ENV_UPDATE\@%@ENV_UPDATE@%g' \
- -e 's%\@CANONICALISE\@%@CANONICALISE@%g'
+ -e 's%\@CANONICALISE\@%@CANONICALISE@%g' \
+ -e 's%\@libdir\@%@libdir@%g'
%.bash : %.bash.in
@$(dosed) $< > $@
diff --git a/libs/multilib.bash.in b/libs/multilib.bash.in
index 4225adb..e84670e 100644
--- a/libs/multilib.bash.in
+++ b/libs/multilib.bash.in
@@ -28,3 +28,10 @@ list_libdirs() {
done
echo "${libdirs[@]}"
}
+
+# get_libdir
+# Print the basename of the libdir path
+get_libdir() {
+ local libdir="@libdir@"
+ echo "${libdir##*/}"
+}
diff --git a/misc/eselect-mode.el b/misc/eselect-mode.el
index b51b60b..762137a 100644
--- a/misc/eselect-mode.el
+++ b/misc/eselect-mode.el
@@ -61,7 +61,7 @@
font-lock-type-face))
(defvar eselect-mode-keywords-multilib
- '(("list_libdirs")
+ '(("list_libdirs" "get_libdir")
font-lock-type-face))
(defvar eselect-mode-keywords-package-manager
[gentoo-commits] proj/eselect:master commit in: doc/, /
commit: 75d2ff149684a5b0650abc8256931ae4a224c610 Author: Ulrich Müller gentoo org> AuthorDate: Tue May 29 16:35:59 2018 + Commit: Ulrich Müller gentoo org> CommitDate: Tue May 29 16:35:59 2018 + URL:https://gitweb.gentoo.org/proj/eselect.git/commit/?id=75d2ff14 Replace "dep atom" by "package dependency specification". * doc/developer-guide.txt: Replace the term "dep atom" by "package dependency specification". ChangeLog | 3 +++ doc/developer-guide.txt | 6 +++--- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/ChangeLog b/ChangeLog index 4f6510e..821e7c9 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,8 @@ 2018-05-29 Ulrich Müller + * doc/developer-guide.txt: Replace the term "dep atom" by + "package dependency specification". + * libs/multilib.bash.in (get_libdir): New function. * doc/developer-guide.txt: Describe it. * libs/Makefile.am (dosed): Substitute @libdir@. diff --git a/doc/developer-guide.txt b/doc/developer-guide.txt index 408b2a7..076c5ca 100644 --- a/doc/developer-guide.txt +++ b/doc/developer-guide.txt @@ -503,13 +503,13 @@ The ``best_version`` function , The ``best_version`` function returns the highest available version for -a given package dep atom. +a given package dependency specification. The ``has_version`` function -The ``has_version`` function checks whether a given versioned package -dep atom is installed. +The ``has_version`` function checks whether a package matching a given +dependency specification is installed. The ``get_repositories`` function ,
[gentoo-commits] proj/eselect:master commit in: /, doc/
commit: 1d2b0dece81ad2bf9ed7d37982e291060fbe93dc Author: Ulrich Müller ulm AT gentoo DOT org AuthorDate: Wed Aug 26 07:39:45 2015 + Commit: Ulrich Müller ulm AT gentoo DOT org CommitDate: Wed Aug 26 07:39:45 2015 + 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 u...@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 u...@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
[gentoo-commits] proj/eselect:master commit in: doc/
commit: b88d19c291321e118ca9710dfe281d5c6f2ce6c3 Author: Ulrich Müller ulm AT gentoo DOT org AuthorDate: Sat Jan 24 16:21:15 2015 + Commit: Ulrich Müller ulm AT gentoo DOT org CommitDate: Sat Jan 24 16:21:15 2015 + URL: http://sources.gentoo.org/gitweb/?p=proj/eselect.git;a=commit;h=b88d19c2 Fix typos in documentation. --- doc/developer-guide.txt | 2 +- doc/user-guide.txt | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/developer-guide.txt b/doc/developer-guide.txt index 63e6389..474437d 100644 --- a/doc/developer-guide.txt +++ b/doc/developer-guide.txt @@ -455,7 +455,7 @@ The ``append_config`` Function ,, The ``append_config`` function appends an item to an already stored -value in the modules configuration file. It uses ``load_config`` / +value in the module's configuration file. It uses ``load_config`` / ``store_config`` internally and should be invoked as ``append_config filename key item``. Note that the item will not be appended if it occurs in the key's value already. diff --git a/doc/user-guide.txt b/doc/user-guide.txt index 6960c30..686757d 100644 --- a/doc/user-guide.txt +++ b/doc/user-guide.txt @@ -97,11 +97,11 @@ and --colour, which controls coloured output. The following are standard action names -- each module may provide a subset of these actions: help -Print the modules help screen. +Print the module's help screen. usage -Print information on how to invoke the modules actions. +Print information on how to invoke the module's actions. version -Print the modules version and other useful information. +Print the module's version and other useful information. list Print a set of selectable options. show
[gentoo-commits] proj/eselect:master commit in: doc/
commit: f3287ce9fa29be05396fd9623cc31374e786ed12 Author: Ulrich Müller ulm AT gentoo DOT org AuthorDate: Thu Mar 20 13:04:04 2014 + Commit: Ulrich Müller ulm AT gentoo DOT org CommitDate: Thu Mar 20 13:04:04 2014 + URL: http://git.overlays.gentoo.org/gitweb/?p=proj/eselect.git;a=commit;h=f3287ce9 Fix a old typo (from 2005). --- doc/user-guide.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/user-guide.txt b/doc/user-guide.txt index 894b588..1713b53 100644 --- a/doc/user-guide.txt +++ b/doc/user-guide.txt @@ -132,7 +132,7 @@ A typical session will look like the following for most modules: :: # eselect module set first # eselect module show Active selection: - item1 + first You can usually set items either by name or by number.
[gentoo-commits] proj/eselect:master commit in: doc/
commit: 1d5c7128fd025b4075b10cbd7ea8b54f92941114
Author: Ulrich Müller ulm AT gentoo DOT org
AuthorDate: Thu Mar 20 13:20:11 2014 +
Commit: Ulrich Müller ulm AT gentoo DOT org
CommitDate: Thu Mar 20 13:20:11 2014 +
URL:
http://git.overlays.gentoo.org/gitweb/?p=proj/eselect.git;a=commit;h=1d5c7128
Whitespace.
---
doc/developer-guide.txt | 1 +
doc/release-guide.txt | 1 +
doc/user-guide.txt | 1 +
3 files changed, 3 insertions(+)
diff --git a/doc/developer-guide.txt b/doc/developer-guide.txt
index 23585b8..e56f643 100644
--- a/doc/developer-guide.txt
+++ b/doc/developer-guide.txt
@@ -520,6 +520,7 @@ The ``get_repo_news_dir`` Function
The ``get_repo_news_dir`` function returns the directory where to find
GLEP 42 news items for a given repository.
+
.. Local Variables:
.. mode: rst
.. fill-column: 72
diff --git a/doc/release-guide.txt b/doc/release-guide.txt
index 2a4fd64..05be1d5 100644
--- a/doc/release-guide.txt
+++ b/doc/release-guide.txt
@@ -42,6 +42,7 @@ Sign it (there may be a dist-sign target in the future). ::
$ gpg --armor --detach-sign ${P}.tar.xz
+
.. Local Variables:
.. mode: rst
.. fill-column: 72
diff --git a/doc/user-guide.txt b/doc/user-guide.txt
index 1713b53..0afb954 100644
--- a/doc/user-guide.txt
+++ b/doc/user-guide.txt
@@ -136,6 +136,7 @@ A typical session will look like the following for most
modules: ::
You can usually set items either by name or by number.
+
.. Local Variables:
.. mode: rst
.. fill-column: 72
[gentoo-commits] proj/eselect:master commit in: /, doc/
commit: db7ee885d7d800d375220618f72b0a4b82a956ef Author: Ulrich Müller ulm AT gentoo DOT org AuthorDate: Thu Mar 20 14:21:34 2014 + Commit: Ulrich Müller ulm AT gentoo DOT org CommitDate: Thu Mar 20 14:21:34 2014 + 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 u...@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
[gentoo-commits] proj/eselect:master commit in: doc/
commit: ef3481ab4c0c0dff4ea38069c75a7854509be5a0
Author: Ulrich Müller ulm AT gentoo DOT org
AuthorDate: Thu Mar 20 18:39:04 2014 +
Commit: Ulrich Müller ulm AT gentoo DOT org
CommitDate: Thu Mar 20 18:39:04 2014 +
URL:
http://git.overlays.gentoo.org/gitweb/?p=proj/eselect.git;a=commit;h=ef3481ab
developer-guide.txt: Fix wording for arch function.
---
doc/developer-guide.txt | 8
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/doc/developer-guide.txt b/doc/developer-guide.txt
index 2191ad5..63e6389 100644
--- a/doc/developer-guide.txt
+++ b/doc/developer-guide.txt
@@ -481,10 +481,10 @@ These are implemented in ``libs/package-manager.bash``.
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 lookup-table based on the ``HOSTTYPE`` and
-``OSTYPE`` bash variables.
+The ``arch`` function returns the correct value of the ``ARCH`` variable
+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
,,,
[gentoo-commits] proj/eselect:master commit in: /, doc/
commit: 66c4b410b6a45c1c3fd4d2acc9edf77b339143ce Author: Ulrich Müller ulm AT gentoo DOT org AuthorDate: Thu Mar 20 18:35:25 2014 + Commit: Ulrich Müller ulm AT gentoo DOT org CommitDate: Thu Mar 20 18:35:25 2014 + 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 u...@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.
[gentoo-commits] proj/eselect:master commit in: /, doc/
commit: 15532aca7c2a3a452d4822da83c1baf368266ead Author: Ulrich Müller ulm AT gentoo DOT org AuthorDate: Thu Mar 20 18:55:07 2014 + Commit: Ulrich Müller ulm AT gentoo DOT org CommitDate: Thu Mar 20 18:55:07 2014 + 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 u...@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
