summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorjan.nijtmans <nijtmans@users.sourceforge.net>2021-05-25 09:30:20 (GMT)
committerjan.nijtmans <nijtmans@users.sourceforge.net>2021-05-25 09:30:20 (GMT)
commit7a8268505cac1cc8c99d7be4c9d6c4654eecc49c (patch)
tree52200189ed4442727318a91f9025457075dbb88f /doc
parent7e1b8cda49fafb05b1483a53ece838ddeb7ad753 (diff)
downloadtcl-7a8268505cac1cc8c99d7be4c9d6c4654eecc49c.zip
tcl-7a8268505cac1cc8c99d7be4c9d6c4654eecc49c.tar.gz
tcl-7a8268505cac1cc8c99d7be4c9d6c4654eecc49c.tar.bz2
Fix [3f9b4e0c81]: CrtObjCmd.3, NRE.3, SplitList.3: constify cmdName, list
(actually quite a few more where the documentation didn't match the header files ....)
Diffstat (limited to 'doc')
-rw-r--r--doc/Access.32
-rw-r--r--doc/AddErrInfo.34
-rw-r--r--doc/Backslash.32
-rw-r--r--doc/CrtObjCmd.32
-rw-r--r--doc/Eval.32
-rw-r--r--doc/GetCwd.36
-rw-r--r--doc/NRE.32
-rw-r--r--doc/RegExp.34
-rw-r--r--doc/SplitList.32
9 files changed, 13 insertions, 13 deletions
diff --git a/doc/Access.3 b/doc/Access.3
index 699d7ed..5a29ec2 100644
--- a/doc/Access.3
+++ b/doc/Access.3
@@ -20,7 +20,7 @@ int
\fBTcl_Stat\fR(\fIpath\fR, \fIstatPtr\fR)
.SH ARGUMENTS
.AS "struct stat" *statPtr out
-.AP char *path in
+.AP "const char" *path in
Native name of the file to check the attributes of.
.AP int mode in
Mask consisting of one or more of \fBR_OK\fR, \fBW_OK\fR, \fBX_OK\fR and
diff --git a/doc/AddErrInfo.3 b/doc/AddErrInfo.3
index caba125..d6580be 100644
--- a/doc/AddErrInfo.3
+++ b/doc/AddErrInfo.3
@@ -49,7 +49,7 @@ Interpreter in which to record information.
The code returned from script evaluation.
.AP Tcl_Obj *options
A dictionary of return options.
-.AP char *message in
+.AP "const char" *message in
For \fBTcl_AddErrorInfo\fR,
this is a conventional C string to append to the \fB\-errorinfo\fR return option.
For \fBTcl_AddObjErrorInfo\fR,
@@ -66,7 +66,7 @@ appending to the \fB\-errorinfo\fR return option.
If negative, all bytes up to the first null byte are used.
.AP Tcl_Obj *errorObjPtr in
The \fB\-errorcode\fR return option will be set to this value.
-.AP char *element in
+.AP "const char" *element in
String to record as one element of the \fB\-errorcode\fR return option.
Last \fIelement\fR argument must be NULL.
.AP va_list argList in
diff --git a/doc/Backslash.3 b/doc/Backslash.3
index 0805f8e..1a807f6 100644
--- a/doc/Backslash.3
+++ b/doc/Backslash.3
@@ -18,7 +18,7 @@ char
\fBTcl_Backslash\fR(\fIsrc, countPtr\fR)
.SH ARGUMENTS
.AS char *countPtr out
-.AP char *src in
+.AP "const char" *src in
Pointer to a string starting with a backslash.
.AP int *countPtr out
If \fIcountPtr\fR is not NULL, \fI*countPtr\fR gets filled
diff --git a/doc/CrtObjCmd.3 b/doc/CrtObjCmd.3
index 6714bd7..6025c68 100644
--- a/doc/CrtObjCmd.3
+++ b/doc/CrtObjCmd.3
@@ -46,7 +46,7 @@ Tcl_Command
.AS Tcl_CmdDeleteProc *deleteProc in/out
.AP Tcl_Interp *interp in
Interpreter in which to create a new command or that contains a command.
-.AP char *cmdName in
+.AP "const char" *cmdName in
Name of command.
.AP Tcl_ObjCmdProc *proc in
Implementation of the new command: \fIproc\fR will be called whenever
diff --git a/doc/Eval.3 b/doc/Eval.3
index e241794..be1598a 100644
--- a/doc/Eval.3
+++ b/doc/Eval.3
@@ -65,7 +65,7 @@ null terminating character. If \-1, then all characters up to the
first null byte are used.
.AP "const char" *script in
Points to first byte of script to execute (null-terminated and UTF-8).
-.AP char *part in
+.AP "const char" *part in
String forming part of a Tcl script.
.AP va_list argList in
An argument list which must have been initialized using
diff --git a/doc/GetCwd.3 b/doc/GetCwd.3
index f4f37a1..b19f587 100644
--- a/doc/GetCwd.3
+++ b/doc/GetCwd.3
@@ -17,7 +17,7 @@ char *
\fBTcl_GetCwd\fR(\fIinterp\fR, \fIbufferPtr\fR)
.sp
int
-\fBTcl_Chdir\fR(\fIpath\fR)
+\fBTcl_Chdir\fR(\fIdirName\fR)
.SH ARGUMENTS
.AS Tcl_DString *bufferPtr in/out
.AP Tcl_Interp *interp in
@@ -27,7 +27,7 @@ This dynamic string is used to store the current working directory.
At the time of the call it should be uninitialized or free. The
caller must eventually call \fBTcl_DStringFree\fR to free up
anything stored here.
-.AP char *path in
+.AP "const char" *dirName in
File path in UTF\-8 format.
.BE
@@ -45,7 +45,7 @@ must call \fBTcl_DStringFree()\fR when the result is no longer needed.
The format of the path is UTF\-8.
.PP
\fBTcl_Chdir\fR changes the applications current working directory to
-the value specified in \fIpath\fR. The format of the passed in string
+the value specified in \fIdirName\fR. The format of the passed in string
must be UTF\-8. The function returns -1 on error or 0 on success.
.SH KEYWORDS
diff --git a/doc/NRE.3 b/doc/NRE.3
index 20efe2f..28576ba 100644
--- a/doc/NRE.3
+++ b/doc/NRE.3
@@ -40,7 +40,7 @@ void
.AS Tcl_CmdDeleteProc *interp in
.AP Tcl_Interp *interp in
The relevant Interpreter.
-.AP char *cmdName in
+.AP "const char" *cmdName in
Name of the command to create.
.AP Tcl_ObjCmdProc *proc in
Called in order to evaluate a command. Is often just a small wrapper that uses
diff --git a/doc/RegExp.3 b/doc/RegExp.3
index aa757bc..1d578bb 100644
--- a/doc/RegExp.3
+++ b/doc/RegExp.3
@@ -51,14 +51,14 @@ can be efficiently searched.
.AP Tcl_Obj *patObj in/out
Refers to the value from which to get a regular expression. The
compiled regular expression is cached in the value.
-.AP char *text in
+.AP "const char" *text in
Text to search for a match with a regular expression.
.AP "const char" *pattern in
String in the form of a regular expression pattern.
.AP Tcl_RegExp regexp in
Compiled regular expression. Must have been returned previously
by \fBTcl_GetRegExpFromObj\fR or \fBTcl_RegExpCompile\fR.
-.AP char *start in
+.AP "const char" *start in
If \fItext\fR is just a portion of some other string, this argument
identifies the beginning of the larger string.
If it is not the same as \fItext\fR, then no
diff --git a/doc/SplitList.3 b/doc/SplitList.3
index d19ca14..863e322 100644
--- a/doc/SplitList.3
+++ b/doc/SplitList.3
@@ -36,7 +36,7 @@ int
.AP Tcl_Interp *interp out
Interpreter to use for error reporting. If NULL, then no error message
is left.
-.AP char *list in
+.AP "const char" *list in
Pointer to a string with proper list structure.
.AP int *argcPtr out
Filled in with number of elements in \fIlist\fR.