Attachment "preserve.patch" to
ticket [483989ffff]
added by
dgp
2001-11-21 06:57:17.
Index: doc/Preserve.3
===================================================================
RCS file: /cvsroot/tcl/tcl/doc/Preserve.3,v
retrieving revision 1.2
diff -u -r1.2 Preserve.3
--- doc/Preserve.3 1998/09/14 18:39:49 1.2
+++ doc/Preserve.3 2001/11/20 23:54:04
@@ -89,6 +89,12 @@
\fIclientData\fR argument to \fBTcl_EventuallyFree\fR for historical
reasons, but the value is the same.
.PP
+When the \fIclientData\fR argument to \fBTcl_EventuallyFree\fR
+refers to storage allocated and returned by a prior call to
+\fBTcl_Alloc\fR or another function of the Tcl library, then the
+\fIfreeProc\fR argument should be given the special value of
+\fBTCL_DYNAMIC\fR.
+.PP
This mechanism can be used to solve the problem described above
by placing \fBTcl_Preserve\fR and \fBTcl_Release\fR calls around
actions that may cause undesired storage re-allocation. The
@@ -98,6 +104,9 @@
The implementation does not depend in any way on the internal
structure of the objects being freed; it keeps the reference
counts in a separate structure.
+
+.SH "SEE ALSO"
+Tcl_Interp, Tcl_Alloc
.SH KEYWORDS
free, reference count, storage
