summaryrefslogtreecommitdiffstats
path: root/doc/Interp.3
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2005-04-06 20:55:16 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2005-04-06 20:55:16 (GMT)
commit596f07e4bfed21c35b29972c3be0428e9cd51b5c (patch)
tree5d41883299c2e8bedcd2b437b39c4cbfab40c071 /doc/Interp.3
parent854b41f3a7f5c48e906218248a4d28354d4c02e3 (diff)
downloadtcl-596f07e4bfed21c35b29972c3be0428e9cd51b5c.zip
tcl-596f07e4bfed21c35b29972c3be0428e9cd51b5c.tar.gz
tcl-596f07e4bfed21c35b29972c3be0428e9cd51b5c.tar.bz2
Purge old and inaccurate .VS/.VE macros.
Diffstat (limited to 'doc/Interp.3')
-rw-r--r--doc/Interp.36
1 files changed, 1 insertions, 5 deletions
diff --git a/doc/Interp.3 b/doc/Interp.3
index a67c9f1..108c654 100644
--- a/doc/Interp.3
+++ b/doc/Interp.3
@@ -5,7 +5,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: Interp.3,v 1.7 2004/11/12 09:01:25 das Exp $
+'\" RCS: @(#) $Id: Interp.3,v 1.8 2005/04/06 20:55:21 dkf Exp $
'\"
.so man.macros
.TH Tcl_Interp 3 7.5 Tcl "Tcl Library Procedures"
@@ -60,7 +60,6 @@ should point to an empty string.
Normally, results are assumed to be statically allocated,
which means that the contents will not change before the next time
\fBTcl_Eval\fR is called or some other command procedure is invoked.
-.VS
In this case, the \fIfreeProc\fR field must be zero.
Alternatively, a command procedure may dynamically
allocate its return value (e.g. using \fBTcl_Alloc\fR)
@@ -69,7 +68,6 @@ In this case, the command procedure must also set \fIinterp->freeProc\fR
to the address of a procedure that can free the value, or \fBTCL_DYNAMIC\fR
if the storage was allocated directly by Tcl or by a call to
\fBTcl_Alloc\fR.
-.VE
If \fIinterp->freeProc\fR is non-zero, then Tcl will call \fIfreeProc\fR
to free the space pointed to by \fIinterp->result\fR before it
invokes the next command.
@@ -81,10 +79,8 @@ macro should be used for this purpose).
\fIFreeProc\fR should have arguments and result that match the
\fBTcl_FreeProc\fR declaration above: it receives a single
argument which is a pointer to the result value to free.
-.VS
In most applications \fBTCL_DYNAMIC\fR is the only non-zero value ever
used for \fIfreeProc\fR.
-.VE
However, an application may store a different procedure address
in \fIfreeProc\fR in order to use an alternate memory allocator
or in order to do other cleanup when the result memory is freed.