comparison docs/introduction.rst @ 683:3062b63325c4

Docs
author Franz Glasner <fzglas.hg@dom66.de>
date Sat, 10 Jun 2023 11:40:05 +0200
parents 7c41a52253bf
children 57fe110c50c8
comparison
equal deleted inserted replaced
682:7c41a52253bf 683:3062b63325c4
357 357
358 Must be Filters are **not** supported. 358 Must be Filters are **not** supported.
359 359
360 Think of them as symbolic links. 360 Think of them as symbolic links.
361 361
362 See also chapter `Configuration tree references`_.
363
362 3. The namespace ``OS`` 364 3. The namespace ``OS``
363 365
364 Available functions: 366 Available functions:
365 367
366 ``cwd`` 368 ``cwd``
513 515
514 516
515 Configuration tree references 517 Configuration tree references
516 ----------------------------- 518 -----------------------------
517 519
518 With ``{{ref:#my.other.key}}`` 520 Syntax is ``{{ref:#my.other.key}}``.
519 521
520 - think of it as a sort of a symbolic link to other parts of the 522 - Think of it as a sort of a symbolic link to other parts of the
521 configuration tree 523 configuration tree.
522 - by employing the special namespace ``ref`` 524 - They occupy the special namespace ``ref``.
523 - can not be quoted currently in variable interpolation syntax 525 - Note that they can not be quoted currently in variable interpolation syntax.
524 - No special handling when merging is done -- merging is agnostic of 526 - No special handling when merging is done -- merging is agnostic of
525 tree references 527 tree references.
526 - Keys within :meth:`.Configuration.getvar_s`, 528 - Keys within :meth:`.Configuration.getvar_s`,
527 :py:meth:`.Configuration.getvar`, :py:meth:`.Configuration.getvarl` 529 :py:meth:`.Configuration.getvar`, :py:meth:`.Configuration.getvarl`
528 and :py:meth:`.Configuration.getvarl_s` are handled 530 and :py:meth:`.Configuration.getvarl_s` are handled.
529 - in :py:meth:`.Configuration.getvar` only, when it is the directly 531 - In :py:meth:`.Configuration.getvar` a reference handled only when it
530 referenced value 532 is the directly referenced value
531 - recursive expansion in :py:meth:`.Configuration.getvar_s` and 533 - Recursive expansion in :py:meth:`.Configuration.getvar_s` and
532 :py:meth:`.Configuration.getvarl_s`: 534 :py:meth:`.Configuration.getvarl_s`:
533 beware of recursive (direct or indirect) tree references 535 beware of recursive (direct or indirect) tree references.
536 - References do work as root paths of `Jailed Configurations`_.
534 537
535 538
536 .. _quoting: 539 .. _quoting:
537 540
538 Quoting 541 Quoting