changeset 683:3062b63325c4

Docs
author Franz Glasner <fzglas.hg@dom66.de>
date Sat, 10 Jun 2023 11:40:05 +0200
parents 7c41a52253bf
children a9eef98e5038
files docs/introduction.rst
diffstat 1 files changed, 14 insertions(+), 11 deletions(-) [+]
line wrap: on
line diff
--- a/docs/introduction.rst	Sat Jun 10 04:08:40 2023 +0200
+++ b/docs/introduction.rst	Sat Jun 10 11:40:05 2023 +0200
@@ -359,6 +359,8 @@
 
    Think of them as symbolic links.
 
+   See also chapter `Configuration tree references`_.
+
 3. The namespace ``OS``
 
    Available functions:
@@ -515,22 +517,23 @@
 Configuration tree references
 -----------------------------
 
-With ``{{ref:#my.other.key}}``
+Syntax is ``{{ref:#my.other.key}}``.
 
-- think of it as a sort of a symbolic link to other parts of the
-  configuration tree
-- by employing the special namespace ``ref``
-- can not be quoted currently in variable interpolation syntax
+- Think of it as a sort of a symbolic link to other parts of the
+  configuration tree.
+- They occupy the special namespace ``ref``.
+- Note that they can not be quoted currently in variable interpolation syntax.
 - No special handling when merging is done -- merging is agnostic of
-  tree references
+  tree references.
 - Keys within :meth:`.Configuration.getvar_s`,
   :py:meth:`.Configuration.getvar`, :py:meth:`.Configuration.getvarl`
-  and :py:meth:`.Configuration.getvarl_s`  are handled
-- in :py:meth:`.Configuration.getvar` only, when it is the directly
-  referenced value
-- recursive expansion in :py:meth:`.Configuration.getvar_s` and
+  and :py:meth:`.Configuration.getvarl_s`  are handled.
+- In :py:meth:`.Configuration.getvar` a reference handled only when it
+  is the directly referenced value
+- Recursive expansion in :py:meth:`.Configuration.getvar_s` and
   :py:meth:`.Configuration.getvarl_s`:
-  beware of recursive (direct or indirect) tree references
+  beware of recursive (direct or indirect) tree references.
+- References do work as root paths of `Jailed Configurations`_.
 
 
 .. _quoting: