summaryrefslogtreecommitdiffstats
path: root/txr.1
diff options
context:
space:
mode:
authorKaz Kylheku <kaz@kylheku.com>2020-10-16 06:42:59 -0700
committerKaz Kylheku <kaz@kylheku.com>2020-10-16 06:42:59 -0700
commit11801dbdc034a43cdb5865ed6e1b55c4dd761e22 (patch)
tree70cb8706dd1b3a6459bd394b66123992280f16c6 /txr.1
parentde8bd6233c62718c592694a2b8463e329567d85f (diff)
downloadtxr-11801dbdc034a43cdb5865ed6e1b55c4dd761e22.tar.gz
txr-11801dbdc034a43cdb5865ed6e1b55c4dd761e22.tar.bz2
txr-11801dbdc034a43cdb5865ed6e1b55c4dd761e22.zip
doc: add missing detail to env function.
* txr.1: The env function actually returns a cached list. Spell out that the function is not required to construct a new list.
Diffstat (limited to 'txr.1')
-rw-r--r--txr.18
1 files changed, 8 insertions, 0 deletions
diff --git a/txr.1 b/txr.1
index ad5aa9d5..d03525a5 100644
--- a/txr.1
+++ b/txr.1
@@ -58860,6 +58860,14 @@ contains an
(equal) character somewhere, separating the variable name
from its value.
+Multiple calls to
+.code env
+may return the same list, or lists which share structure.
+
+If a list returned by
+.code env
+is modified, the behavior is unspecified.
+
See also: the
.code env-hash
function.