summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorpooryorick <com.digitalsmarties@pooryorick.com>2023-04-12 13:30:39 (GMT)
committerpooryorick <com.digitalsmarties@pooryorick.com>2023-04-12 13:30:39 (GMT)
commitcf6c56c88d5339f1a4106b80aa7209ee5f061e50 (patch)
tree155947fa3710efc77fc09abcf12c46652e30fcb6 /doc
parentb571892e4f3f2776d9794279256e3532a2c2c861 (diff)
downloadtcl-cf6c56c88d5339f1a4106b80aa7209ee5f061e50.zip
tcl-cf6c56c88d5339f1a4106b80aa7209ee5f061e50.tar.gz
tcl-cf6c56c88d5339f1a4106b80aa7209ee5f061e50.tar.bz2
Correct spelling errors in comments and documentation, but also a non-comment
corrections in history.tcl and tcltest.test.
Diffstat (limited to 'doc')
-rw-r--r--doc/Cancel.34
-rw-r--r--doc/Ensemble.34
-rw-r--r--doc/Eval.36
-rw-r--r--doc/FileSystem.34
-rw-r--r--doc/OpenFileChnl.32
-rw-r--r--doc/SubstObj.32
-rw-r--r--doc/info.n2
-rw-r--r--doc/memory.n2
-rw-r--r--doc/namespace.n2
-rw-r--r--doc/next.n2
-rw-r--r--doc/pkgMkIndex.n2
-rw-r--r--doc/tcltest.n4
12 files changed, 18 insertions, 18 deletions
diff --git a/doc/Cancel.3 b/doc/Cancel.3
index 73edaf6..027fb09 100644
--- a/doc/Cancel.3
+++ b/doc/Cancel.3
@@ -26,7 +26,7 @@ Error message to use in the cancellation, or NULL to use a default message. If
not NULL, this object will have its reference count decremented before
\fBTcl_CancelEval\fR returns.
.AP int flags in
-ORed combination of flag bits that specify additional options.
+OR'ed combination of flag bits that specify additional options.
For \fBTcl_CancelEval\fR, only \fBTCL_CANCEL_UNWIND\fR is currently
supported. For \fBTcl_Canceled\fR, only \fBTCL_LEAVE_ERR_MSG\fR and
\fBTCL_CANCEL_UNWIND\fR are currently supported.
@@ -47,7 +47,7 @@ Extensions can use this function to check to see if they should abort a long
running command. This function is thread sensitive and may only be called
from the thread the interpreter was created in.
.SS "FLAG BITS"
-Any ORed combination of the following values may be used for the
+Any OR'ed combination of the following values may be used for the
\fIflags\fR argument to procedures such as \fBTcl_CancelEval\fR:
.TP 20
\fBTCL_CANCEL_UNWIND\fR
diff --git a/doc/Ensemble.3 b/doc/Ensemble.3
index b768fd6..71a53ac 100644
--- a/doc/Ensemble.3
+++ b/doc/Ensemble.3
@@ -69,14 +69,14 @@ The name of the ensemble command to be created.
The namespace to which the ensemble command is to be bound, or NULL
for the current namespace.
.AP int ensFlags in
-An ORed set of flag bits describing the basic configuration of the
+An OR'ed set of flag bits describing the basic configuration of the
ensemble. Currently only one bit has meaning, \fBTCL_ENSEMBLE_PREFIX\fR,
which is present when the ensemble command should also match
unambiguous prefixes of subcommands.
.AP Tcl_Obj *cmdNameObj in
A value holding the name of the ensemble command to look up.
.AP int flags in
-An ORed set of flag bits controlling the behavior of
+An OR'ed set of flag bits controlling the behavior of
\fBTcl_FindEnsemble\fR. Currently only \fBTCL_LEAVE_ERR_MSG\fR is supported.
.AP Tcl_Command token in
A normal command token that refers to an ensemble command, or which
diff --git a/doc/Eval.3 b/doc/Eval.3
index 02a8da5..bccb696 100644
--- a/doc/Eval.3
+++ b/doc/Eval.3
@@ -49,7 +49,7 @@ modified to hold the result or error message from the script.
.AP Tcl_Obj *objPtr in
A Tcl value containing the script to execute.
.AP int flags in
-ORed combination of flag bits that specify additional options.
+OR'ed combination of flag bits that specify additional options.
\fBTCL_EVAL_GLOBAL\fR and \fBTCL_EVAL_DIRECT\fR are currently supported.
.AP "const char" *fileName in
Name of a file containing a Tcl script.
@@ -107,7 +107,7 @@ in code for string comparison, you can use
which will be safely substituted by the Tcl interpreter into
.QW ^Z .
.PP
-\fBTcl_EvalObjv\fR executes a single pre-parsed command instead of a
+\fBTcl_EvalObjv\fR executes a single preparsed command instead of a
script. The \fIobjc\fR and \fIobjv\fR arguments contain the values
of the words for the Tcl command, one word in each value in
\fIobjv\fR. \fBTcl_EvalObjv\fR evaluates the command and returns
@@ -159,7 +159,7 @@ in practice. This function is deprecated and will be removed in Tcl 9.0.
.SH "FLAG BITS"
.PP
-Any ORed combination of the following values may be used for the
+Any OR'ed combination of the following values may be used for the
\fIflags\fR argument to procedures such as \fBTcl_EvalObjEx\fR:
.TP 23
\fBTCL_EVAL_DIRECT\fR
diff --git a/doc/FileSystem.3 b/doc/FileSystem.3
index e7cc4ab..7cbbded 100644
--- a/doc/FileSystem.3
+++ b/doc/FileSystem.3
@@ -233,7 +233,7 @@ The value to set in the operation.
.AP Tcl_Obj **objPtrRef out
Filled with a value containing the result of the operation.
.AP Tcl_Obj *resultPtr out
-Pre-allocated value in which to store (using
+Preallocated value in which to store (using
\fBTcl_ListObjAppendElement\fR) the list of
files or directories which are successfully matched.
.AP int mode in
@@ -483,7 +483,7 @@ is a Tcl_Obj specifying the contents of the symbolic link given by
by the caller, which should call \fBTcl_DecrRefCount\fR when the result is no
longer needed. If the \fItoPtr\fR is not NULL, Tcl should create a link
of one of the types passed in in the \fIlinkAction\fR flag. This flag is
-an ORed combination of \fBTCL_CREATE_SYMBOLIC_LINK\fR and \fBTCL_CREATE_HARD_LINK\fR.
+an OR'ed combination of \fBTCL_CREATE_SYMBOLIC_LINK\fR and \fBTCL_CREATE_HARD_LINK\fR.
Where a choice exists (i.e.\ more than one flag is passed in), the Tcl
convention is to prefer symbolic links. When a link is successfully
created, the return value should be \fItoPtr\fR (which is therefore
diff --git a/doc/OpenFileChnl.3 b/doc/OpenFileChnl.3
index e8ed521..1c6f619 100644
--- a/doc/OpenFileChnl.3
+++ b/doc/OpenFileChnl.3
@@ -599,7 +599,7 @@ their possible values are described in the manual entry for the Tcl
\fBfconfigure\fR command. Other options can be added by each channel type.
These channel type specific options are described in the manual entry for
the Tcl command that creates a channel of that type; for example, the
-additional options for TCP based channels are described in the manual entry
+additional options for TCP-based channels are described in the manual entry
for the Tcl \fBsocket\fR command.
The procedure normally returns \fBTCL_OK\fR. If an error occurs, it returns
\fBTCL_ERROR\fR and calls \fBTcl_SetErrno\fR to store an appropriate POSIX
diff --git a/doc/SubstObj.3 b/doc/SubstObj.3
index fa30fb1..f10e01d 100644
--- a/doc/SubstObj.3
+++ b/doc/SubstObj.3
@@ -24,7 +24,7 @@ message.
.AP Tcl_Obj *objPtr in
A Tcl value containing the string to perform substitutions on.
.AP int flags in
-ORed combination of flag bits that specify which substitutions to
+OR'ed combination of flag bits that specify which substitutions to
perform. The flags \fBTCL_SUBST_COMMANDS\fR,
\fBTCL_SUBST_VARIABLES\fR and \fBTCL_SUBST_BACKSLASHES\fR are
currently supported, and \fBTCL_SUBST_ALL\fR is provided as a
diff --git a/doc/info.n b/doc/info.n
index 86263db..8a61ba9 100644
--- a/doc/info.n
+++ b/doc/info.n
@@ -172,7 +172,7 @@ The body of a script provided to \fBeval\fR or \fBuplevel\fR.
.TP
\fBprecompiled\fR\0\0\0\0\0\0\0\0
.
-A pre-compiled script (loadable by the package
+A precompiled script (loadable by the package
\fBtbcload\fR), and no further information is available.
.RE
.TP
diff --git a/doc/memory.n b/doc/memory.n
index 4d6a7d1..fc3ff99 100644
--- a/doc/memory.n
+++ b/doc/memory.n
@@ -41,7 +41,7 @@ of packets and bytes allocated.
.TP
\fBmemory init \fR[\fBon\fR|\fBoff\fR]
.
-Turn on or off the pre-initialization of all allocated memory
+Turn on or off the preinitialization of all allocated memory
with bogus bytes. Useful for detecting the use of uninitialized
values.
.TP
diff --git a/doc/namespace.n b/doc/namespace.n
index 3196cac..1773555 100644
--- a/doc/namespace.n
+++ b/doc/namespace.n
@@ -161,7 +161,7 @@ this command first finds the matching exported commands.
It then checks whether any of those commands
were previously imported by the current namespace.
If so, this command deletes the corresponding imported commands.
-In effect, this un-does the action of a \fBnamespace import\fR command.
+In effect, this undoes the action of a \fBnamespace import\fR command.
.TP
\fBnamespace import \fR?\fB\-force\fR? ?\fIpattern\fR \fIpattern ...\fR?
.
diff --git a/doc/next.n b/doc/next.n
index f731335..624e058 100644
--- a/doc/next.n
+++ b/doc/next.n
@@ -96,7 +96,7 @@ forward to the proper implementation of the method (which it does by invoking
the \fBnext\fR command as filters are inserted into the front of the method
call chain) and is responsible for returning the result of \fBnext\fR.
.PP
-Filters are invoked when processing an invokation of the \fBunknown\fR
+Filters are invoked when processing an invocation of the \fBunknown\fR
method because of a failure to locate a method implementation, but \fInot\fR
when invoking either constructors or destructors. (Note however that the
\fBdestroy\fR method is a conventional method, and filters are invoked as
diff --git a/doc/pkgMkIndex.n b/doc/pkgMkIndex.n
index 5a6b905..f98cbcd 100644
--- a/doc/pkgMkIndex.n
+++ b/doc/pkgMkIndex.n
@@ -108,7 +108,7 @@ it immediately upon \fBpackage require\fR. This is not compatible with
the use of \fIauto_reset\fR, and therefore its use is discouraged.
.TP 15
\fB\-load \fIpkgPat\fR
-The index process will pre-load any packages that exist in the
+The index process will preload any packages that exist in the
current interpreter and match \fIpkgPat\fR into the child interpreter used to
generate the index. The pattern match uses string match rules, but without
making case distinctions.
diff --git a/doc/tcltest.n b/doc/tcltest.n
index 5a53699..965ed64 100644
--- a/doc/tcltest.n
+++ b/doc/tcltest.n
@@ -625,14 +625,14 @@ the test suite is being run on a Unix platform.
.PP
Each \fBtest\fR should include whatever \fB\-constraints\fR are
required to constrain it to run only where appropriate. Several
-constraints are pre-defined in the \fBtcltest\fR package, listed
+constraints are predefined in the \fBtcltest\fR package, listed
below. The registration of user-defined constraints is performed
by the \fBtestConstraint\fR command. User-defined constraints
may appear within a test file, or within the script specified
by the \fBconfigure \-load\fR or \fBconfigure \-loadfile\fR
options.
.PP
-The following is a list of constraints pre-defined by the
+The following is a list of constraints predefined by the
\fBtcltest\fR package itself:
.TP
\fIsingleTestInterp\fR