summaryrefslogtreecommitdiffstats
path: root/doc/DumpActiveMemory.3
diff options
context:
space:
mode:
authordgp <dgp@users.sourceforge.net>2001-12-28 23:36:31 (GMT)
committerdgp <dgp@users.sourceforge.net>2001-12-28 23:36:31 (GMT)
commitd03180362037487dc4c3b1db39fdfef913c6e45a (patch)
tree3e6e8fb2ceb72322d141f778af9e66bd22b95fb0 /doc/DumpActiveMemory.3
parentd279f3a31ab8738baedcb41295db291eb30ab96d (diff)
downloadtcl-d03180362037487dc4c3b1db39fdfef913c6e45a.zip
tcl-d03180362037487dc4c3b1db39fdfef913c6e45a.tar.gz
tcl-d03180362037487dc4c3b1db39fdfef913c6e45a.tar.bz2
* generic/tclCkalloc.c (MemoryCmd, TclFinalizeMemorySubsystem):
Added the [memory onexit] command, intended to replace [checkmem]. * doc/DumpActiveMemory.3: * doc/memory.n: Updated documentation for [memory] and related matters. [Bug 487677] * mac/tclMacBOAMain.c (Tcl_Main, CheckmemCmd): Removed all the machinery for the [checkmem] command that is completely duplicated by code in generic/tclCkalloc.c. * generic/tclBinary.c: * generic/tclListObj.c: * generic/tclObj.c: * generic/tclStringObj.c: Removed references to [checkmem] in comments, referencing [memory active] instead, since it is documented.
Diffstat (limited to 'doc/DumpActiveMemory.3')
-rw-r--r--doc/DumpActiveMemory.311
1 files changed, 6 insertions, 5 deletions
diff --git a/doc/DumpActiveMemory.3 b/doc/DumpActiveMemory.3
index 991c4f7..ee6d0e1 100644
--- a/doc/DumpActiveMemory.3
+++ b/doc/DumpActiveMemory.3
@@ -3,7 +3,7 @@
'\" Copyright (c) 2000 by Scriptics Corporation.
'\" All rights reserved.
'\"
-'\" RCS: @(#) $Id: DumpActiveMemory.3,v 1.4 2001/05/03 23:52:56 hobbs Exp $
+'\" RCS: @(#) $Id: DumpActiveMemory.3,v 1.5 2001/12/28 23:36:31 dgp Exp $
'\"
.so man.macros
.TH "Tcl_DumpActiveMemory" 3 8.1 Tcl "Tcl Library Procedures"
@@ -37,8 +37,9 @@ Line number at which the call to \fBTcl_ValidateAllMemory\fR is made
.SH DESCRIPTION
These functions provide access to Tcl memory debugging information.
-They are only available when Tcl has been compiled with
-\fBTCL_MEM_DEBUG\fR defined at compile-time.
+They are only functional when Tcl has been compiled with
+\fBTCL_MEM_DEBUG\fR defined at compile-time. When \fBTCL_MEM_DEBUG\fR
+is not defined, these functions are all no-ops.
.PP
\fBTcl_DumpActiveMemory\fR will output a list of all currently
allocated memory to the specified file. The information output for
@@ -49,8 +50,8 @@ especially useful to call \fBTcl_DumpActiveMemory\fR after the Tcl
interpreter has been deleted.
.PP
\fBTcl_InitMemory\fR adds the Tcl \fBmemory\fR command to the
-interpreter given by \fIinterp\fR. It is called by \fBTcl_Main\fR
-when Tcl has been compiled with \fBTCL_MEM_DEBUG\fR defined.
+interpreter given by \fIinterp\fR. \fBTcl_InitMemory\fR is called
+by \fBTcl_Main\fR.
.PP
\fBTcl_ValidateAllMemory\fR forces a validation of the guard zones of
all currently allocated blocks of memory. Normally validation of a