diff options
| author | Sean Whitton <spwhitton@spwhitton.name> | 2021-06-25 09:27:25 -0700 |
|---|---|---|
| committer | Sean Whitton <spwhitton@spwhitton.name> | 2021-06-25 16:10:57 -0700 |
| commit | ce792f5e0a6aed1c4b8c284a1a142f22126127a7 (patch) | |
| tree | 6d0f4fc37e475e3d919cb65d82e383b0954f4a82 /doc | |
| parent | 35d1b56ce8f26f0de78db47d5ff2e9b07fac5ebd (diff) | |
| download | consfigurator-ce792f5e0a6aed1c4b8c284a1a142f22126127a7.tar.gz | |
prerequisite data: reserve _CONTEXT for consfigs
Signed-off-by: Sean Whitton <spwhitton@spwhitton.name>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/data.rst | 12 |
1 files changed, 9 insertions, 3 deletions
diff --git a/doc/data.rst b/doc/data.rst index 481ff94..a32acb1 100644 --- a/doc/data.rst +++ b/doc/data.rst @@ -24,6 +24,12 @@ other purposes. ``HOSTNAME`` (and usually nowhere else, except in the case of, e.g., a public key). ``PATH`` must be absolute, not relative. +- ``(_CONTEXT . ITEM)`` is an arbitrary prerequisite data context named + ``CONTEXT``; typically ``CONTEXT`` will be a network or grouping name, + rather than referring to a single host. ``ITEM`` might be a path or some + other identifier. Reserved for consfigs; will not be used by property + definitions included with Consfigurator. + - ``("--lisp-system" . SYSTEM)`` means the data is Lisp code which, when loaded, defines the packages and symbols contained in the ASDF system ``SYSTEM`` @@ -43,9 +49,9 @@ other purposes. - ``("--luks-passphrase" . VOLUME-LABEL)`` means a LUKS passphrase for volume with label ``VOLUME-LABEL``. -(Proposed convention: Except for the first item above, these reserved names -should start with ``--`` and use ``--`` to separate parameter values within -the string. Hostnames cannot start with a hyphen.) +(Proposed convention: Except for the first two items above, these reserved +names should start with ``--`` and use ``--`` to separate parameter values +within the string. Hostnames cannot start with a hyphen.) Mechanics --------- |