summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2012-04-16 06:05:25 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2012-04-16 06:05:25 (GMT)
commitc15c9e5f26e373ec9674b39dc42d2c3500c65b5c (patch)
treefc9524194bb6a03b43340b04110277aa514f03b5
parent004c3152e32651a2491c2adbb107306c6c4c003d (diff)
downloadtcl-c15c9e5f26e373ec9674b39dc42d2c3500c65b5c.zip
tcl-c15c9e5f26e373ec9674b39dc42d2c3500c65b5c.tar.gz
tcl-c15c9e5f26e373ec9674b39dc42d2c3500c65b5c.tar.bz2
* doc/FileSystem.3 (Tcl_FSOpenFileChannelProc): [Bug 3518244]: Fixed
documentation of this filesystem callback function; it must not register its created channel - that's the responsibility of the caller of Tcl_FSOpenFileChannel - as that leads to reference leaks.
-rw-r--r--ChangeLog7
-rw-r--r--doc/FileSystem.37
2 files changed, 11 insertions, 3 deletions
diff --git a/ChangeLog b/ChangeLog
index 3ef4bd8..2d77f14 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2012-04-16 Donal K. Fellows <dkf@users.sf.net>
+
+ * doc/FileSystem.3 (Tcl_FSOpenFileChannelProc): [Bug 3518244]: Fixed
+ documentation of this filesystem callback function; it must not
+ register its created channel - that's the responsibility of the caller
+ of Tcl_FSOpenFileChannel - as that leads to reference leaks.
+
2012-04-11 Jan Nijtmans <nijtmans@users.sf.net>
* win/tclWinInit.c: [Bug 3448512]: clock scan "1958-01-01" fails only
diff --git a/doc/FileSystem.3 b/doc/FileSystem.3
index 7475989..3cb2c7e 100644
--- a/doc/FileSystem.3
+++ b/doc/FileSystem.3
@@ -446,7 +446,7 @@ In addition, if \fIinterp\fR is non-NULL, \fBTcl_FSOpenFileChannel\fR
leaves an error message in \fIinterp\fR's result after any error.
.PP
The newly created channel is not registered in the supplied interpreter; to
-register it, use \fBTcl_RegisterChannel\fR, described below.
+register it, use \fBTcl_RegisterChannel\fR.
If one of the standard channels, \fBstdin, stdout\fR or \fBstderr\fR was
previously closed, the act of creating the new channel also assigns it as a
replacement for the standard channel.
@@ -991,8 +991,9 @@ In addition, if \fIinterp\fR is non-NULL, the
\fBTcl_FSOpenFileChannelProc\fR leaves an error message in \fIinterp\fR's
result after any error.
.PP
-The newly created channel is not registered in the supplied
-interpreter; to register it, use \fBTcl_RegisterChannel\fR. If one of
+The newly created channel must not registered in the supplied
+interpreter; that task is up to the caller of
+\fBTcl_FSOpenFileChannel\fR (if necessary). If one of
the standard channels, \fBstdin, stdout\fR or \fBstderr\fR was
previously closed, the act of creating the new channel also assigns it
as a replacement for the standard channel.