[gentoo-commits] proj/R_overlay:master commit in: doc/rst/

[André Erdmann]

commit:     8c08fcc1d159d64c89f12415eab6dd487e5cd3b2
Author:     André Erdmann <dywi <AT> mailerd <DOT> de>
AuthorDate: Mon Jan 28 23:27:31 2013 +0000
Commit:     André Erdmann <dywi <AT> mailerd <DOT> de>
CommitDate: Mon Jan 28 23:37:04 2013 +0000
URL:        http://git.overlays.gentoo.org/gitweb/?p=proj/R_overlay.git;a=commit;h=8c08fcc1

doc/rst: Configuration Reference

added SYMLINK_DISTROOT, SYMLINK_DISTROOT_TMP options

---
 doc/rst/usage.rst |   31 +++++++++++++++++++++++++++++++
 1 files changed, 31 insertions(+), 0 deletions(-)

diff --git a/doc/rst/usage.rst b/doc/rst/usage.rst
index 46e5e00..45457f3 100644
--- a/doc/rst/usage.rst
+++ b/doc/rst/usage.rst
@@ -1332,6 +1332,37 @@ OVERLAY_NAME
 
    Defaults to *R_Overlay*.
 
+.. _OVERLAY_SYMLINK_DISTROOT_ROOT:
+
+OVERLAY_SYMLINK_DISTROOT_ROOT
+   Root directory where per-package (name) symlink directories will be
+   created during Manifest file creation.
+
+   Defaults to <not set>, which is only valid if OVERLAY_SYMLINK_DISTROOT_TMP_
+   is set to true, in which case a directory in the user's $TMPDIR will be
+   used.
+
+.. _OVERLAY_SYMLINK_DISTROOT_TMP:
+
+OVERLAY_SYMLINK_DISTROOT_TMP
+   A *bool* that sets whether the symlink distroot is a temporary (true)
+   or persistent (false) directory.
+
+   A temporary directory will be wiped at exit
+   whereas a persistent one will only be cleaned up
+   (remove broken symlinks, ...).
+
+
+.. _SYMLINK_DISTROOT:
+
+SYMLINK_DISTROOT
+   Alias to OVERLAY_SYMLINK_DISTROOT_ROOT_.
+
+.. _SYMLINK_DISTROOT_TMP:
+
+SYMLINK_DISTROOT_TMP
+   Alias to OVERLAY_SYMLINK_DISTROOT_TMP_.
+
 --------------------
  other config files
 --------------------