summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authordgp <dgp@users.sourceforge.net>2020-01-08 22:25:36 (GMT)
committerdgp <dgp@users.sourceforge.net>2020-01-08 22:25:36 (GMT)
commit8ef7bd41b66cc77db4b4f07d09ed1faf96ab43c8 (patch)
treebb743eb685e2c62bbd42aa5e2ef246340b38552d /doc
parent0d799f84b35077fabac550318d24e79d28acbe32 (diff)
downloadtcl-8ef7bd41b66cc77db4b4f07d09ed1faf96ab43c8.zip
tcl-8ef7bd41b66cc77db4b4f07d09ed1faf96ab43c8.tar.gz
tcl-8ef7bd41b66cc77db4b4f07d09ed1faf96ab43c8.tar.bz2
Improvements to doc changes from TIPs 422 and 512.
Diffstat (limited to 'doc')
-rw-r--r--doc/AddErrInfo.33
-rw-r--r--doc/Eval.33
-rw-r--r--doc/Panic.39
-rw-r--r--doc/SetResult.32
-rw-r--r--doc/StaticPkg.32
-rw-r--r--doc/StringObj.34
-rw-r--r--doc/Tcl_Main.32
7 files changed, 17 insertions, 8 deletions
diff --git a/doc/AddErrInfo.3 b/doc/AddErrInfo.3
index 0b59349..5b0fe5a 100644
--- a/doc/AddErrInfo.3
+++ b/doc/AddErrInfo.3
@@ -247,6 +247,9 @@ record instead of a value. Otherwise, it is similar to
.PP
\fBTcl_SetErrorCodeVA\fR is the same as \fBTcl_SetErrorCode\fR except that
instead of taking a variable number of arguments it takes an argument list.
+Interfaces using argument lists have been found to be nonportable in practice.
+This function is deprecated and will be removed in Tcl 9.0.
+
.PP
The procedure \fBTcl_GetErrorLine\fR is used to read the integer value
of the \fB\-errorline\fR return option without the overhead of a full
diff --git a/doc/Eval.3 b/doc/Eval.3
index f7c6976..1abe6f2 100644
--- a/doc/Eval.3
+++ b/doc/Eval.3
@@ -156,7 +156,8 @@ of arguments. \fBTcl_VarEval\fR is now deprecated.
.PP
\fBTcl_VarEvalVA\fR is the same as \fBTcl_VarEval\fR except that
instead of taking a variable number of arguments it takes an argument
-list. Like \fBTcl_VarEval\fR, \fBTcl_VarEvalVA\fR is deprecated.
+list. Interfaces using argument lists have been found to be nonportable
+in practice. This function is deprecated and will be removed in Tcl 9.0.
.SH "FLAG BITS"
.PP
diff --git a/doc/Panic.3 b/doc/Panic.3
index f3f8043..53b84da 100644
--- a/doc/Panic.3
+++ b/doc/Panic.3
@@ -86,6 +86,9 @@ The typical use of \fBTcl_SetPanicProc\fR arranges for the error message
to be displayed or reported in a manner more suitable for the
application or the platform.
.PP
+\fBTcl_SetPanicProc\fR can not be used in stub-enabled extensions. Its symbol
+entry in the stub table is deprecated and it will be removed in Tcl 9.0.
+.PP
Although the primary callers of \fBTcl_Panic\fR are the procedures of
the Tcl library, \fBTcl_Panic\fR is a public function and may be called
by any extension or application that wishes to abort the process and
@@ -93,11 +96,9 @@ have a panic message displayed the same way that panic messages from Tcl
will be displayed.
.PP
\fBTcl_PanicVA\fR is the same as \fBTcl_Panic\fR except that instead of
-taking a variable number of arguments it takes an argument list. This
+taking a variable number of arguments it takes an argument list. Interfaces
+using argument lists have been found to be nonportable in practice. This
function is deprecated and will be removed in Tcl 9.0.
-.PP
-This function can not be used in stub-enabled extensions. Its symbol
-entry in the stub table is deprecated and it will be removed in Tcl 9.0.
.SH "SEE ALSO"
abort(3), printf(3), exec(n), format(n)
.SH KEYWORDS
diff --git a/doc/SetResult.3 b/doc/SetResult.3
index a640956..1622290 100644
--- a/doc/SetResult.3
+++ b/doc/SetResult.3
@@ -145,6 +145,8 @@ call; the last argument in the list must be a NULL pointer.
.PP
\fBTcl_AppendResultVA\fR is the same as \fBTcl_AppendResult\fR except that
instead of taking a variable number of arguments it takes an argument list.
+Interfaces using argument lists have been found to be nonportable in practice.
+This function is deprecated and will be removed in Tcl 9.0.
.PP
\fBTcl_TransferResult\fR transfers interpreter state from \fIsourceInterp\fR
to \fItargetInterp\fR. The two interpreters must have been created in the
diff --git a/doc/StaticPkg.3 b/doc/StaticPkg.3
index 8d04cd1..b22edcc 100644
--- a/doc/StaticPkg.3
+++ b/doc/StaticPkg.3
@@ -65,7 +65,7 @@ error message. The result or error from the initialization procedure will
be returned as the result of the \fBload\fR command that caused the
initialization procedure to be invoked.
.PP
-This function can not be used in stub-enabled extensions. Its symbol
+\fBTcl_StaticPackage\fR can not be used in stub-enabled extensions. Its symbol
entry in the stub table is deprecated and it will be removed in Tcl 9.0.
.SH KEYWORDS
initialization procedure, package, static linking
diff --git a/doc/StringObj.3 b/doc/StringObj.3
index 12fc413..2b665cc 100644
--- a/doc/StringObj.3
+++ b/doc/StringObj.3
@@ -249,7 +249,9 @@ must be a NULL pointer to indicate the end of the list.
.PP
\fBTcl_AppendStringsToObjVA\fR is the same as \fBTcl_AppendStringsToObj\fR
except that instead of taking a variable number of arguments it takes an
-argument list.
+argument list. Interfaces using argument lists have been found to be
+nonportable in practice. This function is deprecated and will be removed
+in Tcl 9.0.
.PP
\fBTcl_AppendLimitedToObj\fR is similar to \fBTcl_AppendToObj\fR
except that it imposes a limit on how many bytes are appended.
diff --git a/doc/Tcl_Main.3 b/doc/Tcl_Main.3
index 816dfeb..dc4f45f 100644
--- a/doc/Tcl_Main.3
+++ b/doc/Tcl_Main.3
@@ -190,7 +190,7 @@ procedure (if any) returns. In non-interactive mode, after
procedure (if any) returns, \fBTcl_Main\fR will also evaluate
the \fBexit\fR command.
.PP
-This function can not be used in stub-enabled extensions.
+\fBTcl_Main\fR can not be used in stub-enabled extensions.
.SH "SEE ALSO"
tclsh(1), Tcl_GetStdChannel(3), Tcl_StandardChannels(3), Tcl_AppInit(3),
exit(n), encoding(n)