* doc/ListObj.3: clarified Tcl_ListObjGetElements docs [Bug: 4080]

	* doc/glob.n: clarified Mac path separator determination docs.


FossilOrigin-Name: 7544ca4f08131d2791ae23f55b774c60bfb81293

2 files changed, 20 insertions, 12 deletions

diff --git a/doc/ListObj.3 b/doc/ListObj.3
index 5a88c3d..9aaf858 100644
--- a/doc/ListObj.3
+++ b/doc/ListObj.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: ListObj.3,v 1.3 1999/08/21 19:40:47 hobbs Exp $
+'\" RCS: @(#) $Id: ListObj.3,v 1.4 2000/01/26 03:37:30 hobbs Exp $
 '\" 
 .so man.macros
 .TH Tcl_ListObj 3 8.0 Tcl "Tcl Library Procedures"
@@ -149,16 +149,16 @@ of the elements in \fIobjc\fR since the list object now refers to them.
 The new list object returned by \fBTcl_NewListObj\fR
 has reference count zero.
 .PP
-\fBTcl_ListObjGetElements\fR returns a count and
-a pointer to an array of the elements in a list object.
-It returns the count by storing it in the address \fIobjcPtr\fR.
-Similarly, it returns the array pointer by storing it
-in the address \fIobjvPtr\fR.
-If \fIlistPtr\fR is not already a list object,
-\fBTcl_ListObjGetElements\fR will attempt to convert it to one;
-if the conversion fails, it returns \fBTCL_ERROR\fR
-and leaves an error message in the interpreter's result object
-if \fIinterp\fR is not NULL.
+\fBTcl_ListObjGetElements\fR returns a count and a pointer to an array of
+the elements in a list object.  It returns the count by storing it in the
+address \fIobjcPtr\fR.  Similarly, it returns the array pointer by storing
+it in the address \fIobjvPtr\fR.
+The memory pointed to is managed by Tcl and should not be freed by the
+caller.
+If \fIlistPtr\fR is not already a list object, \fBTcl_ListObjGetElements\fR
+will attempt to convert it to one; if the conversion fails, it returns
+\fBTCL_ERROR\fR and leaves an error message in the interpreter's result
+object if \fIinterp\fR is not NULL.
 Otherwise it returns \fBTCL_OK\fR after storing the count and array pointer.
 .PP
 \fBTcl_ListObjLength\fR returns the number of elements in the list object
diff --git a/doc/glob.n b/doc/glob.n
index 8d125d4..dcf3cb9 100644
--- a/doc/glob.n
+++ b/doc/glob.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: glob.n,v 1.6 1999/12/12 22:46:38 hobbs Exp $
+'\" RCS: @(#) $Id: glob.n,v 1.7 2000/01/26 03:37:30 hobbs Exp $
 '\" 
 .so man.macros
 .TH glob n 8.3 Tcl "Tcl Built-In Commands"
@@ -146,6 +146,14 @@ directory of the user whose account information resides on the specified NT
 domain server.  Otherwise, user account information is obtained from
 the local computer.  On Windows 95 and 98, \fBglob\fR accepts patterns
 like ``.../'' and ``..../'' for successively higher up parent directories.
+.TP 
+\fBMacintosh\fR 
+. 
+When using the options, \fB\-dir\fR, \fB\-join\fR or \fB\-path\fR, glob
+assumes the directory separator for the entire pattern is the standard
+``:''.  When not using these options, glob examines each pattern argument
+and uses ``/'' unless the pattern contains a ``:''.
+
 
 .SH KEYWORDS
 exist, file, glob, pattern