From c6cad9a80c362fb16803329eb1f55bf319d0c628 Mon Sep 17 00:00:00 2001 From: hobbs Date: Mon, 9 Aug 1999 16:30:34 +0000 Subject: 1999-08-09 Jeff Hobbs * doc/Object.3: clarified Tcl_DecrRefCount docs [Bug: 1952] * doc/array.n: clarified array pattern docs [Bug: 1330] * doc/clock.n: fixed clock docs [Bug: 693] * doc/lindex.n: clarified to account for new end-int behavior. * doc/string.n: fixed formatting errors [Bug: 2188 2189] * doc/tclvars.n: fixed doc error [Bug: 2042] --- doc/Object.3 | 4 ++-- doc/array.n | 6 +++--- doc/clock.n | 6 +++--- doc/lindex.n | 6 ++++-- doc/string.n | 13 +++++++------ doc/tclvars.n | 4 ++-- 6 files changed, 21 insertions(+), 18 deletions(-) diff --git a/doc/Object.3 b/doc/Object.3 index 214695f..42a683f 100644 --- a/doc/Object.3 +++ b/doc/Object.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: Object.3,v 1.3 1999/04/16 00:46:32 stanton Exp $ +'\" RCS: @(#) $Id: Object.3,v 1.4 1999/08/09 16:30:34 hobbs Exp $ '\" .so man.macros .TH Tcl_Obj 3 8.0 Tcl "Tcl Library Procedures" @@ -293,7 +293,7 @@ reference to it from the formal parameter. When the called procedure returns, the interpreter calls \fBTcl_DecrRefCount\fR to decrement each argument's reference count. -When an object's reference count drops to zero, +When an object's reference count drops less than or equal to zero, \fBTcl_DecrRefCount\fR reclaims its storage. Most command procedures do not have to be concerned about reference counting since they use an object's value immediately diff --git a/doc/array.n b/doc/array.n index f18c91e..42fc193 100644 --- a/doc/array.n +++ b/doc/array.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: array.n,v 1.2 1998/09/14 18:39:51 stanton Exp $ +'\" RCS: @(#) $Id: array.n,v 1.3 1999/08/09 16:30:35 hobbs Exp $ '\" .so man.macros .TH array n 7.4 Tcl "Tcl Built-In Commands" @@ -58,14 +58,14 @@ array element. The order of the pairs is undefined. If \fIpattern\fR is not specified, then all of the elements of the array are included in the result. If \fIpattern\fR is specified, then only those elements whose names -match \fIpattern\fR (using the glob-style matching rules of +match \fIpattern\fR (using the matching rules of \fBstring match\fR) are included. If \fIarrayName\fR isn't the name of an array variable, or if the array contains no elements, then an empty list is returned. .TP \fBarray names \fIarrayName\fR ?\fIpattern\fR? Returns a list containing the names of all of the elements in -the array that match \fIpattern\fR (using the glob-style matching +the array that match \fIpattern\fR (using the matching rules of \fBstring match\fR). If \fIpattern\fR is omitted then the command returns all of the element names in the array. diff --git a/doc/clock.n b/doc/clock.n index db8af8a..168d0c0 100644 --- a/doc/clock.n +++ b/doc/clock.n @@ -8,7 +8,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: clock.n,v 1.2 1998/09/14 18:39:51 stanton Exp $ +'\" RCS: @(#) $Id: clock.n,v 1.3 1999/08/09 16:30:35 hobbs Exp $ '\" .so man.macros .TH clock n 7.4 Tcl "Tcl Built-In Commands" @@ -74,11 +74,11 @@ AM/PM indicator. .IP \fB%S\fR Seconds (00 - 59). .IP \fB%U\fR -Week of year (01 - 52), Sunday is the first day of the week. +Week of year (00 - 52), Sunday is the first day of the week. .IP \fB%w\fR Weekday number (Sunday = 0). .IP \fB%W\fR -Week of year (01 - 52), Monday is the first day of the week. +Week of year (00 - 52), Monday is the first day of the week. .IP \fB%x\fR Locale specific date format. .IP \fB%X\fR diff --git a/doc/lindex.n b/doc/lindex.n index 393ee78..58bc2b5 100644 --- a/doc/lindex.n +++ b/doc/lindex.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: lindex.n,v 1.2 1998/09/14 18:39:53 stanton Exp $ +'\" RCS: @(#) $Id: lindex.n,v 1.3 1999/08/09 16:30:35 hobbs Exp $ '\" .so man.macros .TH lindex n 7.4 Tcl "Tcl Built-In Commands" @@ -29,7 +29,9 @@ If \fIindex\fR is negative or greater than or equal to the number of elements in \fIvalue\fR, then an empty string is returned. If \fIindex\fR has the value \fBend\fR, it refers to the last element -in the list. +in the list, and \fBend\-\fIinteger\fR refers to the last element in +the list minus the specified integer offset. + .SH KEYWORDS element, index, list diff --git a/doc/string.n b/doc/string.n index d394d0c..f06c3b6 100644 --- a/doc/string.n +++ b/doc/string.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: string.n,v 1.11 1999/06/24 03:27:56 stanton Exp $ +'\" RCS: @(#) $Id: string.n,v 1.12 1999/08/09 16:30:35 hobbs Exp $ '\" .so man.macros .TH string n 8.1 Tcl "Tcl Built-In Commands" @@ -44,8 +44,8 @@ are used in the comparison. If \fB\-length\fR is negative, it is ignored. If \fB\-nocase\fR is specified, then the strings are compared in a case-insensitive manner. .TP -\fBstring equal ?\fB\-nocase\fR? ?\fB-length int\fR? \fIstring1 -string2\fR Perform a character-by-character comparison of strings +\fBstring equal ?\fB\-nocase\fR? ?\fB-length int\fR? \fIstring1 string2\fR +Perform a character-by-character comparison of strings \fIstring1\fR and \fIstring2\fR. Returns 1 if \fIstring1\fR and \fIstring2\fR are identical, or 0 when not. If \fB\-length\fR is specified, then only the first \fIlength\fR characters are used in the @@ -95,8 +95,8 @@ offset (e.g. \fBend\-1\fR would refer to the "c" in "abcd"). If \fIcharIndex\fR is less than 0 or greater than or equal to the length of the string then an empty string is returned. -.RE .VS 8.1 +.RE .TP \fBstring is \fIclass\fR ?\fB\-strict\fR? ?\fB\-failindex \fIvarname\fR? \fIstring\fR Returns 1 if \fIstring\fR is a valid member of the specified character @@ -151,10 +151,11 @@ Any Unicode word character. That is any alphanumeric character, and any Unicode connector punctuation characters (e.g. underscore). .IP \fBxdigit\fR 10 Any hexadecimal digit character ([0\-9A\-Fa\-f]). -.RE +.PP In the case of \fBboolean\fR, \fBtrue\fR and \fBfalse\fR, if the -function will return 0, the \fIvarname\fR will always be set to 0, +function will return 0, then the \fIvarname\fR will always be set to 0, due to the varied nature of a valid boolean value. +.RE .TP \fBstring last \fIstring1 string2\fR ?\fIstartIndex\fR? .VE 8.1 diff --git a/doc/tclvars.n b/doc/tclvars.n index fed83cd..1a83f3e 100644 --- a/doc/tclvars.n +++ b/doc/tclvars.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: tclvars.n,v 1.5 1999/08/05 16:56:31 hobbs Exp $ +'\" RCS: @(#) $Id: tclvars.n,v 1.6 1999/08/09 16:30:35 hobbs Exp $ '\" .so man.macros .TH tclvars n 8.0 Tcl "Tcl Built-In Commands" @@ -291,7 +291,7 @@ If this variable exists, then the interpreter was compiled with threads enabled. .TP \fBuser\fR -Either \fBwindows\fR, \fBmacintosh\fR, or \fBunix\fR. This identifies the +This identifies the current user based on the login information available on the platform. This comes from the USER or LOGNAME environment variable on Unix, and the value from GetUserName on Windows and Macintosh. -- cgit v0.12