summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKaz Kylheku <kaz@kylheku.com>2017-06-09 22:17:13 -0700
committerKaz Kylheku <kaz@kylheku.com>2017-06-09 22:17:13 -0700
commitec07d15b76092e4fe61198f8d2d9b64d63e2bd23 (patch)
treeda1cf42f65215ad26db3f755dc577a31321f0bb4
parent947047e06b24d025749c136e04f8a49d940e2e36 (diff)
downloadtxr-ec07d15b76092e4fe61198f8d2d9b64d63e2bd23.tar.gz
txr-ec07d15b76092e4fe61198f8d2d9b64d63e2bd23.tar.bz2
txr-ec07d15b76092e4fe61198f8d2d9b64d63e2bd23.zip
doc: carray corrections.
* txr.1: forgotten documentation added: the carray-own function can't be used on a carray which references a buf.
-rw-r--r--txr.119
1 files changed, 12 insertions, 7 deletions
diff --git a/txr.1 b/txr.1
index 24b48b29..70a90197 100644
--- a/txr.1
+++ b/txr.1
@@ -56578,19 +56578,24 @@ nothing, it returns
The
.code carray-own
-function closely resembles
+function resembles
.codn carray-dup ,
-differing from that function only in one crucial detail:
-instead of allocating a duplicate copy of the underlying array storage,
-the
+differing from that function only in in two ways.
+Instead of allocating a duplicate copy of the underlying array storage,
.code carray-own
-function causes
+causes
.meta carray
to
.B assume
-ownership of the existing storage. Also,
+ownership of the existing storage. Secondly, it is an error to use
+.code carray-own
+on a
+.meta carray
+which references a buffer object.
+
+The
.meta carray-own
-returns
+function always returns
.codn nil .
In all other regards, the descriptions of