aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDanny van Dyk <kugelfang@gentoo.org>2005-06-12 14:49:14 +0000
committerDanny van Dyk <kugelfang@gentoo.org>2005-06-12 14:49:14 +0000
commit23939961b7d5f276279c9742065354c39d0a5f1d (patch)
tree8a557f7d9e20ede037f440d938c94cec3692412b /doc
parent2005-06-12 Danny van Dyk <kugelfang@gentoo.org> (diff)
downloadeselect-23939961b7d5f276279c9742065354c39d0a5f1d.tar.gz
eselect-23939961b7d5f276279c9742065354c39d0a5f1d.tar.bz2
eselect-23939961b7d5f276279c9742065354c39d0a5f1d.zip
2005-06-12 Danny van Dyk <kugelfang@gentoo.org>
* libs/config.bash.in: Restructured functions to take a filename as first argument. * modules/{blas,lapack}.eselect: Fixed modules to respect new syntax of *_config functions. * doc/developer-guide.txt: Documented new behaviour of *_config functions. diffstat: doc/developer-guide.txt | 10 ++--- libs/config.bash.in | 92 ++++++++++++++++++++++++------------------------ modules/blas.eselect | 16 ++++---- modules/lapack.eselect | 18 +++++---- 4 files changed, 71 insertions(+), 65 deletions(-) svn path=/trunk/; revision=121
Diffstat (limited to 'doc')
-rw-r--r--doc/developer-guide.txt10
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/developer-guide.txt b/doc/developer-guide.txt
index 9971401..8c95b9e 100644
--- a/doc/developer-guide.txt
+++ b/doc/developer-guide.txt
@@ -270,17 +270,17 @@ These are implemented in ``libs/config.bash``.
The ``store_config`` Function
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The ``store_config`` function saves a key/value pair in the module's
-configuration file (``/etc/eselect/${module}/${module}.config``). This file
+The ``store_config`` function saves a key/value pair in a given
+configuration file which is passed as first argument. This file
is a bash script consisting only of key/value pairs and should not be altered
manually. Comments in the file will be deleted each time ``store_config`` is
-called. The function is invoked as ``store_config modulename key value``.
+called. The function is invoked as ``store_config filename key value``.
The ``load_config`` Function
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The ``load_config`` function loads a stored value from the module's
-configuration file. It is invoked as ``load_config modulename key``
+configuration file. It is invoked as ``load_config filename key``
and prints the associated value.
The ``add_config`` Function
@@ -288,7 +288,7 @@ The ``add_config`` Function
The ``add_config`` function adds an item to an already stored value in the
modules configuration file. It uses ``load_config`` / ``store_config``
-internally and should be invoked as ``add_config modulename key item``.
+internally and should be invoked as ``add_config filename key item``.
Multilib Functions
''''''''''''''''''