diff options
author | Sean Whitton <spwhitton@spwhitton.name> | 2021-02-20 15:46:40 -0700 |
---|---|---|
committer | Sean Whitton <spwhitton@spwhitton.name> | 2021-02-20 15:46:44 -0700 |
commit | 5f1f1118a31a468332faccd0c6afe76f8dbe8dd5 (patch) | |
tree | b00b132b1d5e5c56f9b92678609196d8d5ec3ec7 /doc | |
parent | 6b3d798be11b798b5263cf0921ddf33c1bf7c394 (diff) | |
download | consfigurator-5f1f1118a31a468332faccd0c6afe76f8dbe8dd5.tar.gz |
package nicknaming scheme suggestions
Signed-off-by: Sean Whitton <spwhitton@spwhitton.name>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/introduction.rst | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/introduction.rst b/doc/introduction.rst index ee2038a..f35f441 100644 --- a/doc/introduction.rst +++ b/doc/introduction.rst @@ -126,3 +126,13 @@ All unqualified names of Lisp symbols refer to those exported from the ``CONSFIGURATOR`` package, because it is assumed that this package is imported unqualified into both user consfigs and Lisp packages providing properties, connection types and sources of prerequisite data. + +``FOO.BAR:BAZ`` means a symbol ``BAZ`` defined in +``CONSFIGURATOR.PROPERTY.FOO.BAR``, except that ``DATA.FOO:BAR`` means a +symbol ``BAR`` defined in ``CONSFIGURATOR.PROPERTY.DATA.FOO``. These are the +recommended package nicknaming schemes for use in consfigs, e.g.:: + + (defpackage :com.example.consfig + (:use #:cl #:consfigurator) + (:local-nicknames (#:file #:consfigurator.property.file + #:data.pgp #:consfigurator.data.pgp))) |