summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorvincentdarley <vincentdarley>2002-05-02 20:15:19 (GMT)
committervincentdarley <vincentdarley>2002-05-02 20:15:19 (GMT)
commit7c91f1013324e9413b31489bacb0006f0ec0f997 (patch)
treedefc9cdccd62f7994fe3226776f5ea01c9a04065 /doc
parent35438a5685d2efcfe4ea877ab475aa116222817e (diff)
downloadtcl-7c91f1013324e9413b31489bacb0006f0ec0f997.zip
tcl-7c91f1013324e9413b31489bacb0006f0ec0f997.tar.gz
tcl-7c91f1013324e9413b31489bacb0006f0ec0f997.tar.bz2
fix to 551306
Diffstat (limited to 'doc')
-rw-r--r--doc/FileSystem.36
-rw-r--r--doc/file.n19
2 files changed, 14 insertions, 11 deletions
diff --git a/doc/FileSystem.3 b/doc/FileSystem.3
index c085135..413c119 100644
--- a/doc/FileSystem.3
+++ b/doc/FileSystem.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: FileSystem.3,v 1.21 2002/04/03 08:39:26 vincentdarley Exp $
+'\" RCS: @(#) $Id: FileSystem.3,v 1.22 2002/05/02 20:15:20 vincentdarley Exp $
'\"
.so man.macros
.TH Filesystem 3 8.4 Tcl "Tcl Library Procedures"
@@ -867,7 +867,9 @@ NULL, in which case no type information will be available to users of
the filesystem. The 'type' is used only for informational purposes,
and should be returned as the string representation of the Tcl_Obj
which is returned. A typical return value might be "networked", "zip"
-or "ftp".
+or "ftp". The Tcl_Obj result is owned by the filesystem and so Tcl will
+increment the refCount of that object if it wishes to retain a reference
+to it.
.PP
.CS
typedef Tcl_Obj* Tcl_FSFilesystemPathTypeProc(
diff --git a/doc/file.n b/doc/file.n
index b8c33a8..a59050e 100644
--- a/doc/file.n
+++ b/doc/file.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: file.n,v 1.14 2002/03/24 11:41:48 vincentdarley Exp $
+'\" RCS: @(#) $Id: file.n,v 1.15 2002/05/02 20:15:20 vincentdarley Exp $
'\"
.so man.macros
.TH file n 8.3 Tcl "Tcl Built-In Commands"
@@ -350,14 +350,15 @@ empty string.
Returns a list of two elements, the first of which is the name of the
filesystem to use for the file, and the second an arbitrary string
representing the filesystem-specific nature or type of the location
-within that filesystem. If a filesystem only supports one type of
-file, the second element may be null. For example the native files
-have a first element 'native', and a second element which is a
-platform-specific type name for the file (e.g. 'networked'), or
-possibly the empty string. A generic virtual file system might return
-the list 'vfs ftp' to represent a file on a remote ftp site mounted as
-a virtual filesystem through an extension called 'vfs'. If the file
-does not belong to any filesystem, an error is generated.
+within that filesystem. If a filesystem only supports one type of file,
+the second element may be null. For example the native files have a
+first element 'native', and a second element which is a platform-specific
+type name for the file's system (e.g. 'NTFS', 'FAT', etc), or possibly
+the empty string if no further information is available or if this
+is not implemented. A generic virtual file system might return the list
+'vfs ftp' to represent a file on a remote ftp site mounted as a virtual
+filesystem through an extension called 'vfs'. If the file does not
+belong to any filesystem, an error is generated.
.TP
\fBfile tail \fIname\fR
.