aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSean Whitton <spwhitton@spwhitton.name>2021-05-29 15:12:54 -0700
committerSean Whitton <spwhitton@spwhitton.name>2021-05-30 10:03:03 -0700
commitedbba484918f6de83680a5b29e561fba981e05e9 (patch)
tree9418abacd664e22fe7dde4137d8962825943d168 /doc
parentdc396f800b11fc9aa4bae07df268ad51a2740d8b (diff)
downloadconsfigurator-edbba484918f6de83680a5b29e561fba981e05e9.tar.gz
factor out ENSURE-HOST & call it in hostattrs accessors
Signed-off-by: Sean Whitton <spwhitton@spwhitton.name>
Diffstat (limited to 'doc')
-rw-r--r--doc/hosts.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/hosts.rst b/doc/hosts.rst
index af5104b..1f8a56c 100644
--- a/doc/hosts.rst
+++ b/doc/hosts.rst
@@ -37,3 +37,11 @@ keyword symbols. The semantics of these attributes are documented here:
- ``:APT.MIRROR``: for hosts running Debian or a Debian derivative, the host's
preferred apt mirror
+
+Host designators
+----------------
+
+A string designates a host with that hostname and no properties. Using
+strings to designate hosts is not valid in all contexts -- some macros and
+properties where it might be useful to pass a string instead of a ``HOST``
+object call ``ENSURE-HOST`` to convert, but this is not done everywhere.