aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSean Whitton <spwhitton@spwhitton.name>2021-05-25 14:06:41 -0700
committerSean Whitton <spwhitton@spwhitton.name>2021-05-25 14:10:13 -0700
commit868f7c4042aa75db58ac00c8bd4948a29b1aee4f (patch)
tree7263c777184a7975c2026def4adff11219c2bd55 /doc
parentc5598626d593436e7285728729c178b18a8ffc8d (diff)
downloadconsfigurator-868f7c4042aa75db58ac00c8bd4948a29b1aee4f.tar.gz
add DEFPACKAGE-CONSFIG
Signed-off-by: Sean Whitton <spwhitton@spwhitton.name>
Diffstat (limited to 'doc')
-rw-r--r--doc/introduction.rst14
1 files changed, 7 insertions, 7 deletions
diff --git a/doc/introduction.rst b/doc/introduction.rst
index 47122d7..656e7eb 100644
--- a/doc/introduction.rst
+++ b/doc/introduction.rst
@@ -28,13 +28,10 @@ Try it out / quick start
(in-package :cl-user)
- (defpackage :com.example.consfig
- (:use #:cl #:alexandria #:consfigurator)
- (:local-nicknames (#:os #:consfigurator.property.os)
- (#:apt #:consfigurator.property.apt)
- (#:cmd #:consfigurator.property.cmd)
- (#:file #:consfigurator.property.file)
- (#:chroot #:consfigurator.property.chroot)))
+ ;; this macro is a simple wrapper of DEFPACKAGE which sets up local
+ ;; nicknames for packages providing properties and data sources
+ (consfigurator:defpackage-consfig :com.example.consfig
+ (:use #:cl #:alexandria #:consfigurator))
4. Define some hosts and deployments.
@@ -282,6 +279,9 @@ recommended package nicknaming schemes for use in consfigs, e.g.::
(#:cmd #:consfigurator.property.cmd)
(#:data.pgp #:consfigurator.data.pgp)))
+You can use the ``DEFPACKAGE-CONSFIG`` macro to set up all these local
+nicknames.
+
Portability and stability
-------------------------