aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSean Whitton <spwhitton@spwhitton.name>2021-03-09 09:37:26 -0700
committerSean Whitton <spwhitton@spwhitton.name>2021-03-09 09:37:26 -0700
commitf05636d1e5662bf10893b589f8a232abcfbff6ce (patch)
tree98e964f281236acb460b5d6cb7788eb4ce91f25f
parent00b10d8767c0b9c0fbbd2b5f80bc3098fd7b8a80 (diff)
downloadconsfigurator-f05636d1e5662bf10893b589f8a232abcfbff6ce.tar.gz
add some abbreviations to docs: hostattrs, propspecs
Signed-off-by: Sean Whitton <spwhitton@spwhitton.name>
-rw-r--r--doc/hosts.rst7
-rw-r--r--doc/introduction.rst12
-rw-r--r--doc/propspecs.rst8
3 files changed, 14 insertions, 13 deletions
diff --git a/doc/hosts.rst b/doc/hosts.rst
index 885a447..03e28ec 100644
--- a/doc/hosts.rst
+++ b/doc/hosts.rst
@@ -5,9 +5,10 @@ The HOSTATTRS list
------------------
This is a plist of lists, such that for each keyword symbol identifying a type
-of static informational attribute, there is a list of entries. Property
-``:HOSTATTRS`` subroutines may only push new entries to the front of each such
-sublist, using the function ``PUSH-HOSTATTR``.
+of static informational attribute ("hostattr"), there is a list of entries.
+Property ``:HOSTATTRS`` subroutines may only push new entries to the front of
+each such sublist, using the function ``PUSH-HOSTATTR``. Use
+``GET-HOSTATTRS`` and ``GET-HOSTATTRS-CAR`` to access the lists.
The relationship between older and newer entries in the sublist for each type
of static informational attribute is attribute-dependent. For example, for
diff --git a/doc/introduction.rst b/doc/introduction.rst
index 7450355..9652e98 100644
--- a/doc/introduction.rst
+++ b/doc/introduction.rst
@@ -128,8 +128,8 @@ Host
~~~~
A machine, container, chroot, or similar. Has a plist of static informational
-*host attributes*, usually including at least a hostname, and a property
-application specification defining the properties it has.
+*host attributes* ("hostattrs"), usually including at least a hostname, and a
+property application specification defining the properties it has.
Property
~~~~~~~~
@@ -173,8 +173,8 @@ Root Lisp
The Lisp image you control directly when you execute deployments. Typically
running on your development laptop/workstation (and not as the ``root`` user).
-Property application specification
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Property application specification ("propspec")
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
An ordered list specifying the properties that a host has and/or lacks. For
example,::
@@ -186,8 +186,8 @@ example,::
Property application specifications are always applied in order, so properties
later in the list implicitly depend on properties earlier in the list.
-Unevaluated property application specification
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Unevaluated property application specification ("unevaluated propspec")
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
A property application specification, except in atomic property applications
of the form ``(PROPERTY . ARGS)``, ``ARGS`` are expressions to be evaluated to
diff --git a/doc/propspecs.rst b/doc/propspecs.rst
index b24104c..85c9b69 100644
--- a/doc/propspecs.rst
+++ b/doc/propspecs.rst
@@ -1,5 +1,5 @@
-Property application specifications
-===================================
+Property application specifications ("propspecs")
+=================================================
Combinators
-----------
@@ -7,8 +7,8 @@ Combinators
Currently supported: ``(unapply (foo 1 2 3))``, ``((foo 1 2 3) on-change (bar
4 5 6) on-change (baz 7 8 9))`` and combinations thereof.
-Unevaluated property application specifications
------------------------------------------------
+Unevaluated property application specifications ("unevaluated propspecs")
+-------------------------------------------------------------------------
In an atomic property application within an unevaluated property application
specification, if the symbol naming the property ends with the character