summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorvincentdarley <vincentdarley>2004-04-16 17:33:30 (GMT)
committervincentdarley <vincentdarley>2004-04-16 17:33:30 (GMT)
commit9e2ba558e6f4c228b613a868c542c28c0028691b (patch)
treeb6ea9f0bec42ee68dbfc2ac8b41090d55308d5e8
parentac2d6518c3178b2a08cd39eafe3c1639390eb047 (diff)
downloadtcl-9e2ba558e6f4c228b613a868c542c28c0028691b.zip
tcl-9e2ba558e6f4c228b613a868c542c28c0028691b.tar.gz
tcl-9e2ba558e6f4c228b613a868c542c28c0028691b.tar.bz2
fix to utime documentation
-rw-r--r--ChangeLog5
-rw-r--r--doc/FileSystem.39
2 files changed, 10 insertions, 4 deletions
diff --git a/ChangeLog b/ChangeLog
index 5a80034..35d96cf 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2004-04-16 Vince Darley <vincentdarley@users.sourceforge.net>
+
+ * doc/FileSystem.3: Corrected documentation of Tcl_FSUtime, and
+ the corresponding filesystem driver Tcl_FSUtimeProc. [Bug 935838]
+
2004-04-16 Donal K. Fellows <donal.k.fellows@man.ac.uk>
* doc/socket.n: Added example from [Patch 936245].
diff --git a/doc/FileSystem.3 b/doc/FileSystem.3
index e5ee844..e9d7fe7 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.40 2004/03/17 18:14:12 das Exp $
+'\" RCS: @(#) $Id: FileSystem.3,v 1.41 2004/04/16 17:33:32 vincentdarley Exp $
'\"
.so man.macros
.TH Filesystem 3 8.4 Tcl "Tcl Library Procedures"
@@ -398,7 +398,8 @@ given.
.PP
\fBTcl_FSUtime\fR replaces the library version of utime.
.PP
-For results see 'utime' documentation. If successful, the function
+This returns 0 on success and -1 on error (as per the 'utime'
+documentation). If successful, the function
will update the 'atime' and 'mtime' values of the file given.
.PP
\fBTcl_FSFileAttrsGet\fR implements read access for the hookable 'file
@@ -1097,8 +1098,8 @@ typedef int Tcl_FSUtimeProc(
The access and modification times of the file specified by \fIpathPtr\fR
should be changed to the values given in the \fItval\fR structure.
.PP
-The return value is a standard Tcl result indicating whether an error
-occurred in the process.
+The return value should be 0 on success and -1 on an error, as
+with the system utime().
.SH LINKPROC
.PP
Function to process a \fBTcl_FSLink()\fR call. Should be implemented