# HG changeset patch # User Franz Glasner # Date 1620631032 -7200 # Node ID c8b98285a7b526fabf4b5a75817df742be90bb85 # Parent dde6dea50ea303cd03fdcb39166a421d0201166b docs: some more docu for tree references diff -r dde6dea50ea3 -r c8b98285a7b5 docs/introduction.rst --- a/docs/introduction.rst Mon May 10 09:16:04 2021 +0200 +++ b/docs/introduction.rst Mon May 10 09:17:12 2021 +0200 @@ -451,14 +451,20 @@ With ``{{ref:#my.other.key}}`` -- special namespace ``ref`` +- 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 -- No special handling when merging is done -- Keys within :meth:`.Configuration.getvar_s()` and - :py:meth:`.Configuration.getvar()` are handled -- in :py:meth:`.Configuration.getvar()` only, when it is the directly +- No special handling when merging is done -- merging is agnostic of + 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 expandion in :py:meth:`.Configuration.getvar_s()` expands +- recursive expansion in :py:meth:`.Configuration.getvar_s` and + :py:meth:`.Configuration.getvarl_s`: + beware of recursive (direct or indirect) tree references .. _quoting: