diff options
| author | Sean Whitton <spwhitton@spwhitton.name> | 2021-02-16 18:22:02 -0700 |
|---|---|---|
| committer | Sean Whitton <spwhitton@spwhitton.name> | 2021-02-16 18:22:02 -0700 |
| commit | bae9e93dee235043fb1a278c5966a418378e71cd (patch) | |
| tree | 55ad3195efc9f94a6b63e06aad8c8bbf7226eb2f /doc | |
| parent | d6df52ad4d98d45374e28bd8b4ebd85c07dbb968 (diff) | |
| download | consfigurator-bae9e93dee235043fb1a278c5966a418378e71cd.tar.gz | |
reserve some prerequisite data names
Signed-off-by: Sean Whitton <spwhitton@spwhitton.name>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/guide.rst | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/guide.rst b/doc/guide.rst index db15bba..975c891 100644 --- a/doc/guide.rst +++ b/doc/guide.rst @@ -124,6 +124,20 @@ mechanism for the common need to upload files to controlled hosts. The same mechanism is used internally to upload the Lisp code needed to start up remote Lisp processes for ``:lisp`` connections. +Reserved names for prerequisite data +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +These are exclusive semantics for certain possible pairs of strings +identifying prerequisite data -- to avoid confusion and potential clashes, do +not use prerequisite data identified by strings matching these conditions for +other purposes. + +- ``(HOSTNAME . PATH)`` means the data that should be uploaded to PATH on + HOSTNAME (and nowhere else) + +- ``("lisp-system" . SYSTEM)`` means the data is Lisp code which, when loaded, + defines the packages and symbols contained in the ASDF system SYSTEM. + Representing prerequisite data ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |