diff options
Diffstat (limited to 'doc/DumpActiveMemory.3')
| -rw-r--r-- | doc/DumpActiveMemory.3 | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/doc/DumpActiveMemory.3 b/doc/DumpActiveMemory.3 index 991c4f7..f4d78d1 100644 --- a/doc/DumpActiveMemory.3 +++ b/doc/DumpActiveMemory.3 @@ -3,13 +3,11 @@ '\" Copyright (c) 2000 by Scriptics Corporation. '\" All rights reserved. '\" -'\" RCS: @(#) $Id: DumpActiveMemory.3,v 1.4 2001/05/03 23:52:56 hobbs Exp $ -'\" -.so man.macros .TH "Tcl_DumpActiveMemory" 3 8.1 Tcl "Tcl Library Procedures" +.so man.macros .BS .SH NAME -Tcl_DumpActiveMemory, Tcl_InitMemory, Tcl_ValidateAllMemory \- Validated memory allocation interface. +Tcl_DumpActiveMemory, Tcl_InitMemory, Tcl_ValidateAllMemory \- Validated memory allocation interface .SH SYNOPSIS .nf \fB#include <tcl.h>\fR @@ -24,9 +22,10 @@ void \fBTcl_ValidateAllMemory\fR(\fIfileName, line\fR) .SH ARGUMENTS +.AS Tcl_Interp *fileName .AP Tcl_Interp *interp in Tcl interpreter in which to add commands. -.AP "CONST char" *fileName in +.AP "const char" *fileName in For \fBTcl_DumpActiveMemory\fR, name of the file to which memory information will be written. For \fBTcl_ValidateAllMemory\fR, name of the file from which the call is being made (normally \fB__FILE__\fR). @@ -37,8 +36,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 +49,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 |