summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorKevin B Kenny <kennykb@acm.org>2001-04-04 16:07:20 (GMT)
committerKevin B Kenny <kennykb@acm.org>2001-04-04 16:07:20 (GMT)
commit2c48422a192dbde1b5a70ff98215341aa88272ad (patch)
tree742b0af0f8ca321b69d41c90f80cffe211fd3e73 /doc
parent947cb3910acc0fd7e89f2f78b6f487d6862be815 (diff)
downloadtcl-2c48422a192dbde1b5a70ff98215341aa88272ad.zip
tcl-2c48422a192dbde1b5a70ff98215341aa88272ad.tar.gz
tcl-2c48422a192dbde1b5a70ff98215341aa88272ad.tar.bz2
(TIP#27) Changed a number of Tcl API's to accept "CONST char*"
in place of simple "char*". (kennykb) [Patch #404026]
Diffstat (limited to 'doc')
-rw-r--r--doc/ByteArrObj.34
-rw-r--r--doc/DumpActiveMemory.34
-rw-r--r--doc/InitStubs.36
-rw-r--r--doc/PkgRequire.314
-rw-r--r--doc/StringObj.38
5 files changed, 18 insertions, 18 deletions
diff --git a/doc/ByteArrObj.3 b/doc/ByteArrObj.3
index b3ed34f..f5471db 100644
--- a/doc/ByteArrObj.3
+++ b/doc/ByteArrObj.3
@@ -4,7 +4,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: ByteArrObj.3,v 1.2 1999/03/03 00:38:36 stanton Exp $
+'\" RCS: @(#) $Id: ByteArrObj.3,v 1.3 2001/04/04 16:07:20 kennykb Exp $
'\"
.so man.macros
.TH Tcl_ByteArrayObj 3 8.1 Tcl "Tcl Library Procedures"
@@ -28,7 +28,7 @@ unsigned char *
\fBTcl_SetByteArrayLength\fR(\fIobjPtr, length\fR)
.SH ARGUMENTS
.AS "unsigned char" *lengthPtr in/out
-.AP "unsigned char" *bytes in
+.AP "CONST unsigned char" *bytes in
The array of bytes used to initialize or set a byte-array object.
.AP int length in
The length of the array of bytes. It must be >= 0.
diff --git a/doc/DumpActiveMemory.3 b/doc/DumpActiveMemory.3
index 02b8d81..bbf5b45 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.2 2000/04/28 00:47:48 ericm Exp $
+'\" RCS: @(#) $Id: DumpActiveMemory.3,v 1.3 2001/04/04 16:07:20 kennykb Exp $
'\"
.so man.macros
.TH "Tcl_DumpActiveMemory" 3 8.1 Tcl "Tcl Library Procedures"
@@ -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"v *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).
diff --git a/doc/InitStubs.3 b/doc/InitStubs.3
index 4701927..27dae2f 100644
--- a/doc/InitStubs.3
+++ b/doc/InitStubs.3
@@ -4,7 +4,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: InitStubs.3,v 1.4 1999/05/06 19:14:40 stanton Exp $
+'\" RCS: @(#) $Id: InitStubs.3,v 1.5 2001/04/04 16:07:20 kennykb Exp $
'\"
.so man.macros
.TH Tcl_InitStubs 3 8.1 Tcl "Tcl Library Procedures"
@@ -15,13 +15,13 @@ Tcl_InitStubs \- initialize the Tcl stubs mechanism
.nf
\fB#include <tcl.h>\fR
.sp
-char *
+CONST char *
\fBTcl_InitStubs\fR(\fIinterp, version, exact\fR)
.SH ARGUMENTS
.AS Tcl_Interp *interp in
.AP Tcl_Interp *interp in
Tcl interpreter handle.
-.AP char *version in
+.AP CONST char *version in
A version string consisting of one or more decimal numbers
separated by dots.
.AP int exact in
diff --git a/doc/PkgRequire.3 b/doc/PkgRequire.3
index 40cd542..3164259 100644
--- a/doc/PkgRequire.3
+++ b/doc/PkgRequire.3
@@ -4,7 +4,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: PkgRequire.3,v 1.4 2000/04/14 23:01:53 hobbs Exp $
+'\" RCS: @(#) $Id: PkgRequire.3,v 1.5 2001/04/04 16:07:20 kennykb Exp $
'\"
.so man.macros
.TH Tcl_PkgRequire 3 7.5 Tcl "Tcl Library Procedures"
@@ -15,16 +15,16 @@ Tcl_PkgRequire, Tcl_PkgRequireEx, Tcl_PkgPresent, Tcl_PkgPresentEx, Tcl_PkgProvi
.nf
\fB#include <tcl.h>\fR
.sp
-char *
+CONST char *
\fBTcl_PkgRequire\fR(\fIinterp, name, version, exact\fR)
.sp
-char *
+CONST char *
\fBTcl_PkgRequireEx\fR(\fIinterp, name, version, exact, clientDataPtr\fR)
.sp
-char *
+CONST char *
\fBTcl_PkgPresent\fR(\fIinterp, name, version, exact\fR)
.sp
-char *
+CONST char *
\fBTcl_PkgPresentEx\fR(\fIinterp, name, version, exact, clientDataPtr\fR)
.sp
int
@@ -36,9 +36,9 @@ int
.AS Tcl_FreeProc clientDataPtr
.AP Tcl_Interp *interp in
Interpreter where package is needed or available.
-.AP char *name in
+.AP "CONST char" *name in
Name of package.
-.AP char *version in
+.AP "CONST char" *version in
A version string consisting of one or more decimal numbers
separated by dots.
.AP int exact in
diff --git a/doc/StringObj.3 b/doc/StringObj.3
index 23273d0..4be6eef 100644
--- a/doc/StringObj.3
+++ b/doc/StringObj.3
@@ -4,7 +4,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: StringObj.3,v 1.6 2000/09/14 18:42:29 ericm Exp $
+'\" RCS: @(#) $Id: StringObj.3,v 1.7 2001/04/04 16:07:20 kennykb Exp $
'\"
.so man.macros
.TH Tcl_StringObj 3 8.1 Tcl "Tcl Library Procedures"
@@ -78,7 +78,7 @@ Tcl_Obj *
\fBTcl_ConcatObj\fR(\fIobjc, objv\fR)
.SH ARGUMENTS
.AS Tcl_Interp *appendObjPtr in/out
-.AP char *bytes in
+.AP "CONST char" *bytes in
Points to the first byte of an array of bytes
used to set or append to a string object.
This byte array may contain embedded null bytes
@@ -87,7 +87,7 @@ unless \fIlength\fR is negative.
The number of bytes to copy from \fIbytes\fR when
initializing, setting, or appending to a string object.
If negative, all bytes up to the first null are used.
-.AP Tcl_UniChar *unicode in
+.AP "CONST Tcl_UniChar" *unicode in
Points to the first byte of an array of Unicode characters
used to set or append to a string object.
This byte array may contain embedded null characters
@@ -113,7 +113,7 @@ The object to append to \fIobjPtr\fR in \fBTcl_AppendObjToObj\fR.
.AP int *lengthPtr out
If non-NULL, the location where \fBTcl_GetStringFromObj\fR will store
the the length of an object's string representation.
-.AP char *string in
+.AP "CONST char" *string in
Null-terminated string value to append to \fIobjPtr\fR.
.AP va_list argList in
An argument list which must have been initialised using