From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from lists.gentoo.org (pigeon.gentoo.org [208.92.234.80]) by finch.gentoo.org (Postfix) with ESMTP id D05C81381F3 for ; Thu, 11 Jul 2013 06:14:59 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id 1A18FE0A49; Thu, 11 Jul 2013 06:14:59 +0000 (UTC) Received: from smtp.gentoo.org (smtp.gentoo.org [140.211.166.183]) (using TLSv1 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by pigeon.gentoo.org (Postfix) with ESMTPS id 95AA3E0A49 for ; Thu, 11 Jul 2013 06:14:58 +0000 (UTC) Received: from hornbill.gentoo.org (hornbill.gentoo.org [94.100.119.163]) (using TLSv1 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by smtp.gentoo.org (Postfix) with ESMTPS id 89D3A33E9CA for ; Thu, 11 Jul 2013 06:14:57 +0000 (UTC) Received: from localhost.localdomain (localhost [127.0.0.1]) by hornbill.gentoo.org (Postfix) with ESMTP id 05A4DE468F for ; Thu, 11 Jul 2013 06:14:55 +0000 (UTC) From: "Ulrich Mueller" To: gentoo-commits@lists.gentoo.org Content-Transfer-Encoding: 8bit Content-type: text/plain; charset=UTF-8 Reply-To: gentoo-dev@lists.gentoo.org, "Ulrich Mueller" Message-ID: <1373405436.a4e6b08d41e6384cdfa86f39cb736a6f65a8e452.ulm@gentoo> Subject: [gentoo-commits] proj/eselect:master commit in: libs/, /, doc/ X-VCS-Repository: proj/eselect X-VCS-Files: ChangeLog doc/developer-guide.txt libs/skel.bash.in X-VCS-Directories: libs/ / doc/ X-VCS-Committer: ulm X-VCS-Committer-Name: Ulrich Mueller X-VCS-Revision: a4e6b08d41e6384cdfa86f39cb736a6f65a8e452 X-VCS-Branch: master Date: Thu, 11 Jul 2013 06:14:55 +0000 (UTC) Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-commits@lists.gentoo.org X-Archives-Salt: bbedfaea-35e3-41cc-895f-bd213a90594d X-Archives-Hash: 14f4411288b5c7d85bd9d5f8d684ac60 commit: a4e6b08d41e6384cdfa86f39cb736a6f65a8e452 Author: Ulrich Müller gentoo org> AuthorDate: Tue Jul 9 21:30:36 2013 +0000 Commit: Ulrich Mueller gentoo org> CommitDate: Tue Jul 9 21:30:36 2013 +0000 URL: http://git.overlays.gentoo.org/gitweb/?p=proj/eselect.git;a=commit;h=a4e6b08d Move skel.bash documentation from developer guide to the library itself. * doc/developer-guide.txt: * libs/skel.bash.in: Move skel.bash documentation to the library itself. --- ChangeLog | 4 ++++ doc/developer-guide.txt | 26 -------------------------- libs/skel.bash.in | 42 ++++++++++++++++++++++++++++-------------- 3 files changed, 32 insertions(+), 40 deletions(-) diff --git a/ChangeLog b/ChangeLog index 2d8c614..4bc1be4 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,9 @@ 2013-07-09 Ulrich Müller + * doc/developer-guide.txt: + * libs/skel.bash.in: Move skel.bash documentation to the library + itself. + * doc/developer-guide.txt: Update description of the "arch" function. diff --git a/doc/developer-guide.txt b/doc/developer-guide.txt index 9ecfdd9..23585b8 100644 --- a/doc/developer-guide.txt +++ b/doc/developer-guide.txt @@ -520,32 +520,6 @@ 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. -A Basic Skeleton Library -======================== - -The ``libs/skel.bash`` library provides for a simple eselect module to -switch between implementations of anything that installs to a ``lib*`` -directory (i.e., lib, lib32, lib64). This will satisfy the requirements -for most cases in which one must switch between providers of a certain -library or any package installing a library. - -Creating a simple module ------------------------- - -To use this library, all you need to do is create an eselect module -containing settings for the MODULE and IFACE variables. The MODULE -variable is the name used to refer to the implementations being switched -in help text. The IFACE variable indicates the subdirectory of -/etc/env.d/ in which eselect files for these implementations will be -stored. - -Each package must install a symlink map using the ``add`` action. The -map must use relative symlinks, one source-destination mapping per line -in the form ``source destination``. The source must be relative to the -destination, not absolute. Instead of using ``lib`` or ``lib64`` etc., -you must use @LIBDIR@. The ``libs/skel.bash`` library detects the proper -library directory at runtime. - .. Local Variables: .. mode: rst .. fill-column: 72 diff --git a/libs/skel.bash.in b/libs/skel.bash.in index a70baca..6559370 100644 --- a/libs/skel.bash.in +++ b/libs/skel.bash.in @@ -15,21 +15,35 @@ # You should have received a copy of the GNU General Public License along with # eselect. If not, see . -# To use this library, you must set MODULE and IFACE. -# MODULE is the name you use to refer to whatever it is that you're selecting -# in help text and so forth. -# IFACE is the subdirectory of /etc/env.d/ that eselect config files are stored -# in for these packages. +# This library provides for a simple eselect module to switch between +# implementations of anything that installs to a "lib*" directory (i.e., +# lib, lib32, lib64). This will satisfy the requirements for most cases +# in which one must switch between providers of a certain library or any +# package installing a library. # -# There is a file installed at /etc/env.d/$IFACE/$libdir/config containing the -# CURRENT variable, which is set to the current eselect setting. Also, each -# implementation installs a single file at /etc/env.d/$IFACE/$libdir/$implem. -# This file contains a list of symlinks to be created in "source destination" -# format. You must use relative symlinks. In other words, "source" must be -# relative to "destination" but "destination" must be absolute. You may have -# comments in the symlink map file -- any line containing a '#' is considered -# a comment. One caveat about the symlink map -- instead of using "lib" or -# "lib64" etc, you must use @LIBDIR@. +# Creating a simple module: +# To use this library, all you need to do is create an eselect module +# containing settings for the MODULE and IFACE variables. The MODULE +# variable is the name used to refer to the implementations being +# switched in help text. The IFACE variable indicates the subdirectory +# of /etc/env.d/ in which eselect config files for these implementations +# will be stored. +# +# Each package must install a symlink map using the "add" action. +# The map must use relative symlinks, one source-destination mapping per +# line in the form "source destination". The source must be relative +# to the destination, not absolute. In other words, "source" must be +# relative to "destination" but "destination" must be absolute. One +# caveat about the symlink map - instead of using "lib" or "lib64" etc., +# you must use @LIBDIR@. The "skel.bash" library detects the proper +# library directory at runtime. + +# There is a file installed at /etc/env.d/$IFACE/$libdir/config +# containing the CURRENT variable, which is set to the current eselect +# setting. Also, each implementation installs a single file at +# /etc/env.d/$IFACE/$libdir/$implem containing the symlink map. You may +# have comments in the symlink map file - any line containing a '#' is +# considered a comment. inherit config multilib tests