summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2012-04-16 06:15:09 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2012-04-16 06:15:09 (GMT)
commit3abaea7cf8f37548c22b194ef947257e57f5991d (patch)
treebc271d77fbd11a554314f35a3faba2c42c7137ff
parent6a7ba7b04d63d79b6944f10426385c91f060a4b0 (diff)
parent6865953e8f03dca8e223cc63d4a3ca89f0b9b447 (diff)
downloadtcl-3abaea7cf8f37548c22b194ef947257e57f5991d.zip
tcl-3abaea7cf8f37548c22b194ef947257e57f5991d.tar.gz
tcl-3abaea7cf8f37548c22b194ef947257e57f5991d.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 04a4343..668108b 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-15 Donal K. Fellows <dkf@users.sf.net>
* generic/tclEnsemble.c (NsEnsembleImplementationCmdNR):
diff --git a/doc/FileSystem.3 b/doc/FileSystem.3
index cf785ae..52eeb23 100644
--- a/doc/FileSystem.3
+++ b/doc/FileSystem.3
@@ -582,7 +582,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\fR, \fBstdout\fR or \fBstderr\fR was
previously closed, the act of creating the new channel also assigns it as a
replacement for the standard channel.
@@ -1218,8 +1218,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\fR, \fBstdout\fR or \fBstderr\fR was
previously closed, the act of creating the new channel also assigns it
as a replacement for the standard channel.