[gentoo-commits] proj/R_overlay:master commit in: roverlay/tools/, doc/rst/, doc/html/

[gentoo-commits] proj/R_overlay:master commit in: roverlay/tools/, doc/rst/, doc/html/

[André Erdmann]

commit:     b986da4a2c2caec626eb6a4acd8850c305a6940f
Author:     André Erdmann <dywi <AT> mailerd <DOT> de>
AuthorDate: Sat Jan 25 17:56:06 2014 +0000
Commit:     André Erdmann <dywi <AT> mailerd <DOT> de>
CommitDate: Sat Jan 25 17:56:06 2014 +0000
URL:        http://git.overlays.gentoo.org/gitweb/?p=proj/R_overlay.git;a=commit;h=b986da4a

hook environment: set PORTDIR

---
 doc/html/usage.html     |  7 ++++-
 doc/rst/usage.rst       |  3 +++
 roverlay/tools/shenv.py | 71 +++----------------------------------------------
 3 files changed, 13 insertions(+), 68 deletions(-)

diff --git a/doc/html/usage.html b/doc/html/usage.html
index acffffd..4a48388 100644
--- a/doc/html/usage.html
+++ b/doc/html/usage.html
@@ -2724,6 +2724,11 @@ the config file. An empty string sets the policy to <em>deny all</em>.</p>
 <td>all environment variables starting
 with LC_</td>
 </tr>
+<tr><td>PORTDIR</td>
+<td>config</td>
+<td>path to the main portage tree
+(<a class="reference internal" href="#portdir">PORTDIR</a>, optional)</td>
+</tr>
 <tr><td>ROVERLAY_PHASE</td>
 <td>event</td>
 <td>event that caused the script to run</td>
@@ -4969,7 +4974,7 @@ becomes &quot;loop until resolver closes&quot;.</p>
 </div>
 <div class="footer">
 <hr class="footer" />
-Generated on: 2013-11-14.
+Generated on: 2014-01-25.
 
 </div>
 </body>

diff --git a/doc/rst/usage.rst b/doc/rst/usage.rst
index 15aa3c1..d70d951 100644
--- a/doc/rst/usage.rst
+++ b/doc/rst/usage.rst
@@ -2342,6 +2342,9 @@ the config file. An empty string sets the policy to *deny all*.
    | *LC_\**        | os.environ        | all environment variables starting      |
    |                |                   | with LC\_                               |
    +----------------+-------------------+-----------------------------------------+
+   | PORTDIR        | config            | path to the main portage tree           |
+   |                |                   | (`PORTDIR`_, optional)                  |
+   +----------------+-------------------+-----------------------------------------+
    | ROVERLAY_PHASE | event             | event that caused the script to run     |
    +----------------+-------------------+-----------------------------------------+
    | HAS_CHANGES    | *internal*        | a shbool (``y`` or ``n``) that          |

diff --git a/roverlay/tools/shenv.py b/roverlay/tools/shenv.py
index c087f7a..98cd86d 100644
--- a/roverlay/tools/shenv.py
+++ b/roverlay/tools/shenv.py
@@ -40,73 +40,7 @@ SHENV_VARS_TO_KEEP = frozenset ({
 SHENV_WILDCARD_VARS_TO_KEEP = frozenset ({ 'LC_?*', })
 
 
-# shell env dict quickref
-#  TODO: move this to doc/
-#
-# $PATH, $LOGNAME, $SHLVL, $TERM, [$PWD], $HOME
-#
-#  taken from os.environ
-#
-# $ROVERLAY_PHASE
-#
-#  hook phase (set in run_script())
-#
-# $OVERLAY == $S
-#
-#  overlay directory (depends on config value), initial directory for scripts
-#
-# $OVERLAY_NAME
-#
-#  name of the overlay
-#
-# $DISTROOT
-#
-#  mirror directory (depends on config value)
-#
-# $TMPDIR == $T
-#
-#  depends on config value (+fallback)
-#
-# $ADDITIONS_DIR == $FILESDIR (optional)
-#
-#  depends on config value
-#
-# $WORKDIR
-#
-#  (cachedir.root)
-#
-# $SHLIB (optional)
-#
-#  shell functions dir (if found, ${ADDITIONS_DIR}/shlib)
-#
-# $FUNCTIONS (optional)
-#
-#  core functions file (if found, ${ADDITIONS_DIR}/{shlib,}/functions.sh)
-#
-# $EBUILD
-#
-#  ebuild executable, depends on config value
-#
-# $GIT_EDITOR
-# $GIT_ASKPASS
-#
-#  set to /bin/false
-#
-# $NOSYNC
-#
-#  depends on config value
-#
-# $NO_COLOR
-#
-#  alway false ('n')
-#
-# $DEBUG
-# $VERBOSE
-# $QUIET
-#
-#  shbools that indicate whether debug/verbose/quiet ouput is desired,
-#  depends on log level
-#
+# shell env dict quickref: see doc/rst/usage.rst
 
 # @typedef shbool is SH_TRUE|SH_FALSE, where:
 SH_TRUE  = 'y'
@@ -191,6 +125,9 @@ def setup_env():
 
    ## create shell vars
 
+   # str::dirpath $PORTDIR
+   setup_conf_optional ( 'PORTDIR', 'portdir' )
+
    # str::filepath $ROVERLAY_HOOKRC (optional)
    setup_conf_optional ( 'ROVERLAY_HOOKRC', 'EVENT_HOOK.config_file' )