diff options
| author | Sean Whitton <spwhitton@spwhitton.name> | 2021-03-25 09:19:59 -0700 |
|---|---|---|
| committer | Sean Whitton <spwhitton@spwhitton.name> | 2021-03-25 10:11:30 -0700 |
| commit | 8437e0ca879915c3b00236e703aec6a6151ec701 (patch) | |
| tree | 55a73a614ee788941f211b164c00e6d1e2e9911a /doc | |
| parent | 4170ae1f0dbc98178768857d9bac60c891bf7140 (diff) | |
| download | consfigurator-8437e0ca879915c3b00236e703aec6a6151ec701.tar.gz | |
document working directory conventions
Signed-off-by: Sean Whitton <spwhitton@spwhitton.name>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ideas.rst | 5 | ||||
| -rw-r--r-- | doc/properties.rst | 11 |
2 files changed, 15 insertions, 1 deletions
diff --git a/doc/ideas.rst b/doc/ideas.rst index d84e8e8..aadba1d 100644 --- a/doc/ideas.rst +++ b/doc/ideas.rst @@ -53,7 +53,10 @@ Core - A CONCURRENTLY combinator for property application specifications, which means to apply each of the enclosed properties in parallel. Particularly useful surrounding a set of DEPLOYS applications, to concurrently deploy a - number of hosts. + number of hosts. We use ``WITH-CURRENT-DIRECTORY`` in various places, so we + may not be able to do this using threads. But if we want to do it with lots + of forking, then practically speaking usage of this combinator will be + restricted to connection chains which start up remote Lisp images. - It might be useful to have a restart for the case where an attempt is made to apply a list of properties containing some ``:LISP`` properties with a diff --git a/doc/properties.rst b/doc/properties.rst index 32b5b29..16e69dc 100644 --- a/doc/properties.rst +++ b/doc/properties.rst @@ -10,6 +10,17 @@ special meaning in unevaluated property application specifications. Properties occupy the function cells of symbols, so do not try to define an ordinary function with the same name as a property. +Working directories +------------------- + +Except where specified otherwise in property docstrings, relative paths are +relative to the remote home directory. ``:LISP`` properties may assume they +will be executed in the remote home directory, and ``:POSIX`` properties may +assume that commands will be executed in the remote home directory, and that +relative paths passed to ``READFILE`` and ``WRITEFILE`` are relative to the +remote home directory. Use ``WITH-REMOTE-CURRENT-DIRECTORY`` to change the +remote working directory in a way which ensures it will get changed back. + Property subroutines -------------------- |