diff options
| author |   Ciaran McCreesh <ciaranm@gentoo.org> | 2005-05-10 02:07:42 +0000 |
|---|---|---|
| committer | Ciaran McCreesh <ciaranm@gentoo.org> | 2005-05-10 02:07:42 +0000 |
| commit | c643bc370bfbc85e3b2761963f6d720ae3f72251 (patch) | |
| tree | aba161f5b8217ee489a582c561aa48a6e2e1c176 /doc | |
| parent | convert to use date rather than hard coded versions (diff) | |
| download | eselect-c643bc370bfbc85e3b2761963f6d720ae3f72251.tar.gz eselect-c643bc370bfbc85e3b2761963f6d720ae3f72251.tar.bz2 eselect-c643bc370bfbc85e3b2761963f6d720ae3f72251.zip | |
document manip functions
svn path=/trunk/; revision=91
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/developer-guide.txt | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/developer-guide.txt b/doc/developer-guide.txt index 7b26e71..db5d2e5 100644 --- a/doc/developer-guide.txt +++ b/doc/developer-guide.txt @@ -243,6 +243,25 @@ The ``is_number`` Utility Function Returns true if and only if the parameter is a positive whole number. +Manipulation Functions +'''''''''''''''''''''' + +These are implemented in ``libs/manip.bash``. + +The ``svn_date_to_version`` Utility Function +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The ``svn_date_to_version`` function can be used instead of manually keeping +track of ``VERSION``. It is safe to use in global scope. The canonical usage is +as follows: :: + + SVN_DATE='$Date: $' + VERSION=$(svn_date_to_version "${SVN_DATE}" ) + +Then turn on SVN keyword expansion for the module: :: + + svn propset svn:keywords "Date" modules/foo.eclectic + Configuration Functions ''''''''''''''''''''''' |