summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorjan.nijtmans <nijtmans@users.sourceforge.net>2023-03-27 09:59:14 (GMT)
committerjan.nijtmans <nijtmans@users.sourceforge.net>2023-03-27 09:59:14 (GMT)
commite1fdad425a08599ce5e492ae8087a8406c9ce268 (patch)
tree278076ffc2c807bd189758f2b54eee7a31604ee5 /doc
parent1df3dc0ae2488112b8d9f28bb74b73c508a11210 (diff)
parent49b6ecfb4e17876dec5c9f9edad8d5e0a44cb52c (diff)
downloadtcl-e1fdad425a08599ce5e492ae8087a8406c9ce268.zip
tcl-e1fdad425a08599ce5e492ae8087a8406c9ce268.tar.gz
tcl-e1fdad425a08599ce5e492ae8087a8406c9ce268.tar.bz2
Merge 8.7. Go back to lowercase for POSIX err-messages
Diffstat (limited to 'doc')
-rw-r--r--doc/SetErrno.32
-rw-r--r--doc/SetVar.318
-rw-r--r--doc/encoding.n6
-rw-r--r--doc/package.n2
-rw-r--r--doc/safe.n2
-rw-r--r--doc/tclvars.n2
6 files changed, 16 insertions, 16 deletions
diff --git a/doc/SetErrno.3 b/doc/SetErrno.3
index 3cc0dbc..c202e2e 100644
--- a/doc/SetErrno.3
+++ b/doc/SetErrno.3
@@ -55,7 +55,7 @@ returns a machine-readable textual identifier such as
.QW EACCES
that corresponds to the current value of \fBerrno\fR.
\fBTcl_ErrnoMsg\fR returns a human-readable string such as
-.QW "Permission denied"
+.QW "permission denied"
that corresponds to the value of its
\fIerrorCode\fR argument. The \fIerrorCode\fR argument is
typically the value returned by \fBTcl_GetErrno\fR.
diff --git a/doc/SetVar.3 b/doc/SetVar.3
index eb8333b..d061a2b 100644
--- a/doc/SetVar.3
+++ b/doc/SetVar.3
@@ -250,18 +250,18 @@ and \fBTcl_ObjGetVar2\fR is (if non-NULL) a value with a reference of at least
operated upon.
.PP
The \fInewValuePtr\fR argument to \fBTcl_SetVar2Ex\fR and \fBTcl_ObjSetVar2\fR
-may be an arbitrary reference count value; its reference count will be
-incremented on success. However, it is recommended to not use a zero reference
-count value, as that makes correct handling of the error case tricky.
+may be an arbitrary reference count value. Its reference count is
+incremented on success. On failure, if is reference count is zero, it is
+decremented and freed so the caller need do nothing with it.
.PP
-The \fIpart1\fR argument to \fBTcl_ObjSetVar2\fR and \fBTcl_ObjGetVar2\fR can
-have any reference count; these functions never modify it. It is recommended
-to not use a zero reference count for this argument.
+The \fIpart1Ptr\fR argument to \fBTcl_ObjSetVar2\fR and \fBTcl_ObjGetVar2\fR can
+have any reference count. These functions never modify it.
.PP
-The \fIpart2\fR argument to \fBTcl_ObjSetVar2\fR and \fBTcl_ObjGetVar2\fR, if
+The \fIpart2Ptr\fR argument to \fBTcl_ObjSetVar2\fR and \fBTcl_ObjGetVar2\fR, if
non-NULL, should not have a zero reference count as these functions may
-retain a reference to it (particularly when it is used to create an array
-element that did not previously exist).
+retain a reference to it, particularly when it is used to create an array
+element that did not previously exist, and decrementing the reference count
+later would leave them pointing to a freed Tcl_Obj.
.SH "SEE ALSO"
Tcl_GetObjResult, Tcl_GetStringResult, Tcl_TraceVar
diff --git a/doc/encoding.n b/doc/encoding.n
index 8ede974..e02f316 100644
--- a/doc/encoding.n
+++ b/doc/encoding.n
@@ -96,7 +96,7 @@ Returns a list of the names of encoding profiles. See \fBPROFILES\fR below.
Set the system encoding to \fIencoding\fR. If \fIencoding\fR is
omitted then the command returns the current system encoding. The
system encoding is used whenever Tcl passes strings to system calls.
-\" Do not put .VS on whole section as that messes up the bullet list alignment
+.\" Do not put .VS on whole section as that messes up the bullet list alignment
.SH PROFILES
.PP
.VS "TCL8.7 TIP656"
@@ -172,7 +172,7 @@ These examples use the utility proc below that prints the Unicode code points
comprising a Tcl string.
.PP
.CS
-proc codepoints {s} {join [lmap c [split $s ""] {
+proc codepoints s {join [lmap c [split $s {}] {
string cat U+ [format %.6X [scan $c %c]]}]
}
.CE
@@ -193,8 +193,8 @@ Example 2: Error handling based on profiles:
.PP
The letter \fBA\fR is Unicode character U+0041 and the byte "\ex80" is invalid
in ASCII encoding.
-.CS
.PP
+.CS
% codepoints [encoding convertfrom -profile tcl8 ascii A\ex80]
U+000041 U+000080
% codepoints [encoding convertfrom -profile replace ascii A\ex80]
diff --git a/doc/package.n b/doc/package.n
index 820938c..5687480 100644
--- a/doc/package.n
+++ b/doc/package.n
@@ -286,7 +286,7 @@ then the attempt to set it back to
is ineffective and the mode value remains
.QW latest .
.PP
-When passed any other value as an argument, raise an Invalid argument
+When passed any other value as an argument, raise an invalid argument
error.
.PP
When an interpreter is created, its initial selection mode value is set to
diff --git a/doc/safe.n b/doc/safe.n
index 86f58bc..6e0d948 100644
--- a/doc/safe.n
+++ b/doc/safe.n
@@ -191,7 +191,7 @@ the file was not found:
NOTICE for child interp10 : Created
NOTICE for child interp10 : Setting accessPath=(/foo/bar) staticsok=1 nestedok=0 deletehook=()
NOTICE for child interp10 : auto_path in interp10 has been set to {$p(:0:)}
-ERROR for child interp10 : /foo/bar/init.tcl: No such file or directory
+ERROR for child interp10 : /foo/bar/init.tcl: no such file or directory
.CE
.RE
.SS OPTIONS
diff --git a/doc/tclvars.n b/doc/tclvars.n
index 6e41405..4d1413c 100644
--- a/doc/tclvars.n
+++ b/doc/tclvars.n
@@ -197,7 +197,7 @@ of the error that occurred, such as \fBENOENT\fR; this will
be one of the values defined in the include file errno.h.
The \fImsg\fR element will be a human-readable
message corresponding to \fIerrName\fR, such as
-.QW "No such file or directory"
+.QW "no such file or directory"
for the \fBENOENT\fR case.
.TP
\fBTCL\fR ...