aboutsummaryrefslogtreecommitdiff
path: root/doc/hosts.rst
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 /doc/hosts.rst
parent00b10d8767c0b9c0fbbd2b5f80bc3098fd7b8a80 (diff)
downloadconsfigurator-f05636d1e5662bf10893b589f8a232abcfbff6ce.tar.gz
add some abbreviations to docs: hostattrs, propspecs
Signed-off-by: Sean Whitton <spwhitton@spwhitton.name>
Diffstat (limited to 'doc/hosts.rst')
-rw-r--r--doc/hosts.rst7
1 files changed, 4 insertions, 3 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