aboutsummaryrefslogtreecommitdiff
path: root/doc/connections.rst
diff options
context:
space:
mode:
authorSean Whitton <spwhitton@spwhitton.name>2021-02-18 11:18:09 -0700
committerSean Whitton <spwhitton@spwhitton.name>2021-02-18 11:18:09 -0700
commit28ac2c8b8ba8839a78fc4b6bfea87d5482fb0208 (patch)
treebe7e4a5579f79650b6c282f886c08720619f9312 /doc/connections.rst
parentc8be9aa24f37ff52205e9525756f3338674ccaaf (diff)
downloadconsfigurator-28ac2c8b8ba8839a78fc4b6bfea87d5482fb0208.tar.gz
tidy up existing docs
Signed-off-by: Sean Whitton <spwhitton@spwhitton.name>
Diffstat (limited to 'doc/connections.rst')
-rw-r--r--doc/connections.rst11
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/connections.rst b/doc/connections.rst
new file mode 100644
index 0000000..b3e5e1d
--- /dev/null
+++ b/doc/connections.rst
@@ -0,0 +1,11 @@
+Connections
+===========
+
+Defining connection types
+-------------------------
+
+The code which establishes connections (i.e., implementations of the
+``ESTABLISH-CONNECTION`` generic) is like code in ``:posix`` properties -- it
+should restrict its I/O to ``RUN``, ``RUNLINES``, ``READFILE`` and
+``WRITEFILE``, functions which access the currently active connection. This
+is in order to permit the arbitrary nesting of connections.