aboutsummaryrefslogtreecommitdiff
path: root/doc/introduction.rst
diff options
context:
space:
mode:
authorSean Whitton <spwhitton@spwhitton.name>2021-03-15 17:38:37 -0700
committerSean Whitton <spwhitton@spwhitton.name>2021-03-15 17:38:37 -0700
commit807a6f6058bf6aaa160a0f37bae5d3b3b6ff445d (patch)
tree0fc397463efc88dd9823e6542fd1dc6d9bf04019 /doc/introduction.rst
parentfe9360c286f2c4e002b3c5a98435941fb12d2c64 (diff)
downloadconsfigurator-807a6f6058bf6aaa160a0f37bae5d3b3b6ff445d.tar.gz
update definitions in introduction
Signed-off-by: Sean Whitton <spwhitton@spwhitton.name>
Diffstat (limited to 'doc/introduction.rst')
-rw-r--r--doc/introduction.rst25
1 files changed, 14 insertions, 11 deletions
diff --git a/doc/introduction.rst b/doc/introduction.rst
index 8c1d7dd..aec1c5d 100644
--- a/doc/introduction.rst
+++ b/doc/introduction.rst
@@ -179,15 +179,17 @@ running on your development laptop/workstation (and not as the ``root`` user).
Property application specification ("propspec")
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-An ordered list specifying the properties that a host has and/or lacks. For
-example,::
+A specification, in Consfigurator's DSL, for the properties that a host has
+and/or lacks. For example,::
- '((apt:installed postfix)
- (etc-default:set "locale" "LANG" "en_GB.UTF-8")
- (unapply (com.example.consfig.services:mail-satellite)))
-Property application specifications are always applied in order, so properties
-later in the list implicitly depend on properties earlier in the list.
+ (eseqprops (apt:installed postfix)
+ (etc-default:set "locale" "LANG" "en_GB.UTF-8")
+ (unapply (com.example.consfig.services:mail-satellite)))
+
+Property application specifications are applied in order, so properties later
+in the list usually implicitly depend on properties earlier in the list,
+though some property combinators can undo this.
Unevaluated property application specification ("unevaluated propspec")
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -199,10 +201,11 @@ themselves. An unevaluated property application specification can be
converted into a property application specification by evaluating each of
``ARGS``.
-The main place you will find an unevaluated property application specification
-is in a call to ``DEFHOST``. That macro converts an unevaluated property
-application specification into code which will produce the corresponding
-property application specification.
+The main places you will find an unevaluated property application
+specification is in calls to ``DEFHOST``, ``DEPLOY``, ``DEPLOY-THESE`` and
+``DEFPROPLIST``. Theses macros converts an unevaluated property application
+specification into code which will produce the corresponding property
+application specification.
Prerequisite data
~~~~~~~~~~~~~~~~~