diff options
| author | vincentdarley <vincentdarley> | 2003-06-23 10:49:13 (GMT) |
|---|---|---|
| committer | vincentdarley <vincentdarley> | 2003-06-23 10:49:13 (GMT) |
| commit | b2119b24ffca4e1a1c74f423a02377dc04c323d8 (patch) | |
| tree | ee9a1c51c8befa003bd6957525ced6091defed96 | |
| parent | 413f218a68dc50e3fc9d85fe2a67501baf2e7b5c (diff) | |
| download | tcl-b2119b24ffca4e1a1c74f423a02377dc04c323d8.zip tcl-b2119b24ffca4e1a1c74f423a02377dc04c323d8.tar.gz tcl-b2119b24ffca4e1a1c74f423a02377dc04c323d8.tar.bz2 | |
fs doc fix
| -rw-r--r-- | ChangeLog | 2 | ||||
| -rw-r--r-- | doc/FileSystem.3 | 26 |
2 files changed, 15 insertions, 13 deletions
@@ -4,6 +4,8 @@ do 'file copy foo ""'. [Bug 756951] * tests/fCmd.test: added two new tests for the bug. + * doc/FileSystem.3: documentation fix [Bug 720634] + 2003-06-18 Miguel Sofer <msofer@users.sf.net> * generic/tclNamesp.c (Tcl_Export): removed erroneous comments diff --git a/doc/FileSystem.3 b/doc/FileSystem.3 index dcb92b0..010c408 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.32 2003/02/10 12:50:31 vincentdarley Exp $ +'\" RCS: @(#) $Id: FileSystem.3,v 1.32.2.1 2003/06/23 10:49:14 vincentdarley Exp $ '\" .so man.macros .TH Filesystem 3 8.4 Tcl "Tcl Library Procedures" @@ -779,18 +779,18 @@ representations. .SH PATHINFILESYSTEMPROC .PP The \fIpathInFilesystemProc\fR field contains the address of a function -which is called to determine whether a given path object belongs to -this filesystem or not. Tcl will only call the rest of the filesystem -functions with a path for which this function has returned -\fBTCL_OK\fR. If the path does not belong, \fBTCL_ERROR\fR should be -returned. If \fBTCL_OK\fR is returned, then the optional -\fBclientDataPtr\fR output parameter can be used to return an internal -(filesystem specific) representation of the path, which will be cached -inside the path object, and may be retrieved efficiently by the other -filesystem functions. Tcl will simultaneously cache the fact that this -path belongs to this filesystem. Such caches are invalidated when -filesystem structures are added or removed from Tcl's internal list of -known filesystems. +which is called to determine whether a given path object belongs to this +filesystem or not. Tcl will only call the rest of the filesystem +functions with a path for which this function has returned \fBTCL_OK\fR. +If the path does not belong, -1 should be returned (the behaviour of Tcl +for any other return value is not defined). If \fBTCL_OK\fR is returned, +then the optional \fBclientDataPtr\fR output parameter can be used to +return an internal (filesystem specific) representation of the path, +which will be cached inside the path object, and may be retrieved +efficiently by the other filesystem functions. Tcl will simultaneously +cache the fact that this path belongs to this filesystem. Such caches +are invalidated when filesystem structures are added or removed from +Tcl's internal list of known filesystems. .PP .CS typedef int Tcl_FSPathInFilesystemProc( |