diff options
| author | Sean Whitton <spwhitton@spwhitton.name> | 2021-05-23 14:26:58 -0700 |
|---|---|---|
| committer | Sean Whitton <spwhitton@spwhitton.name> | 2021-05-23 16:55:50 -0700 |
| commit | 70b4d3fae04d455cc8847a94b821d86b9def3d43 (patch) | |
| tree | ffce6266b2eec2ff6a566526a3293821ca3cf23f | |
| parent | aced98144bda3bd4a2ff392639373444bd861b7a (diff) | |
| download | consfigurator-70b4d3fae04d455cc8847a94b821d86b9def3d43.tar.gz | |
add note about use of non-POSIX facilities & docstrings
Signed-off-by: Sean Whitton <spwhitton@spwhitton.name>
| -rw-r--r-- | doc/properties.rst | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/properties.rst b/doc/properties.rst index d0261aa..17fe542 100644 --- a/doc/properties.rst +++ b/doc/properties.rst @@ -105,3 +105,11 @@ They should perform I/O only by calling ``RUN``, ``RUNLINES``, ``READFILE``, running in a Lisp image on the host to which they are to be applied, so they can perform arbitrary I/O in that context. They can also make use of ``RUN``, ``RUNLINES``, ``READFILE`` and ``WRITEFILE`` if desired. + +``:posix`` properties are characterised by the limited set of ways in which +they perform I/O, not by the use of only facilities defined in the Single UNIX +Specification. Nevertheless, if a ``:posix`` property or function intended to +be called by ``:posix`` properties uses non-POSIX facilities, but it is not +obvious given the stated purpose of the property that it will do this, it is +good to mention the use of non-POSIX facilities in the docstring. For +examples of this, see ``USER:HAS-LOGIN-SHELL`` and ``USER:PASSWD-ENTRY``. |