From ce792f5e0a6aed1c4b8c284a1a142f22126127a7 Mon Sep 17 00:00:00 2001 From: Sean Whitton Date: Fri, 25 Jun 2021 09:27:25 -0700 Subject: prerequisite data: reserve _CONTEXT for consfigs Signed-off-by: Sean Whitton --- doc/data.rst | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) (limited to 'doc') 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 --------- -- cgit v1.2.3