summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKaz Kylheku <kaz@kylheku.com>2019-08-21 17:31:13 -0700
committerKaz Kylheku <kaz@kylheku.com>2019-08-21 17:31:13 -0700
commit12c055c3865fca924341abb4d16b3d415e2947d5 (patch)
treee06acf8464195351eb1f3ef37b8778248b2beb27
parent23224e6b7beb2a8a40aa17b1354f2be92a0c488d (diff)
downloadtxr-12c055c3865fca924341abb4d16b3d415e2947d5.tar.gz
txr-12c055c3865fca924341abb4d16b3d415e2947d5.tar.bz2
txr-12c055c3865fca924341abb4d16b3d415e2947d5.zip
doc: note about cptr-obj lifetime.
* txr.1: Include blurb about the independent lifetime of a ctpr made by cptr-obj and the original object. If the original is garbage collected, the ctpr is junk.
-rw-r--r--txr.112
1 files changed, 12 insertions, 0 deletions
diff --git a/txr.1 b/txr.1
index 93c02ab2..0f025e9a 100644
--- a/txr.1
+++ b/txr.1
@@ -49649,6 +49649,18 @@ This symbol becomes the
.code cptr
object's type tag.
+The lifetime of the returned
+.cptr
+object is independent from that of
+.metn object .
+If the lifetime of
+.meta object
+reaches its end before that of the
+.code cptr ,
+the pointer stored inside the
+.code cptr
+becomes invalid.
+
.coNP Function @ int-cptr
.synb
.mets (int-cptr << cptr )