diff options
Diffstat (limited to 'tcl/doc/DumpActiveMemory.3')
| -rw-r--r-- | tcl/doc/DumpActiveMemory.3 | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/tcl/doc/DumpActiveMemory.3 b/tcl/doc/DumpActiveMemory.3 index 285c0f3fffb..6dd8197445f 100644 --- a/tcl/doc/DumpActiveMemory.3 +++ b/tcl/doc/DumpActiveMemory.3 @@ -26,7 +26,7 @@ void .SH ARGUMENTS .AP Tcl_Interp *interp in Tcl interpreter in which to add commands. -.AP 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 +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 |