From 3f8eaee13078461d06f1a41ff520c32e09178ead Mon Sep 17 00:00:00 2001 From: dkf Date: Sun, 2 Sep 2007 22:37:40 +0000 Subject: Doc clarification. --- ChangeLog | 5 +++++ doc/lsearch.n | 11 +++++++---- 2 files changed, 12 insertions(+), 4 deletions(-) diff --git a/ChangeLog b/ChangeLog index 0997f11..72c64d8 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +2007-09-02 Donal K. Fellows + + * doc/lsearch.n: Added note that order of results with the -all option + is that of the input list. It always was, but this makes it crystal. + 2007-08-30 Don Porter * generic/tclCompile.c: Added fflush() calls following all callers of diff --git a/doc/lsearch.n b/doc/lsearch.n index 726f060..21c8680 100644 --- a/doc/lsearch.n +++ b/doc/lsearch.n @@ -7,7 +7,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: lsearch.n,v 1.26 2005/07/12 09:39:53 dkf Exp $ +'\" RCS: @(#) $Id: lsearch.n,v 1.27 2007/09/02 22:37:41 dkf Exp $ '\" .so man.macros .TH lsearch n 8.5 Tcl "Tcl Built-In Commands" @@ -58,8 +58,11 @@ is treated exactly like \fB-exact\fR when either \fB\-all\fR or These options may be given with all matching styles. .TP \fB\-all\fR -Changes the result to be the list of all matching indices (or all -matching values if \fB\-inline\fR is specified as well.) +. +Changes the result to be the list of all matching indices (or all matching +values if \fB\-inline\fR is specified as well.) If indices are returned, the +indices will be in numeric order. If values are returned, the order of the +values will be the order of those values within the input \fIlist\fR. .TP \fB\-inline\fR The matching value is returned instead of its index (or an empty @@ -71,7 +74,7 @@ This negates the sense of the match, returning the index of the first non-matching value in the list. .TP \fB\-start\fR\0\fIindex\fR -The list is searched starting at position \fIindex\fR. +The list is searched starting at position \fIindex\fR. .VS 8.5 The interpretation of the \fIindex\fR value is the same as for the command \fBstring index\fR, supporting simple index -- cgit v0.12