summaryrefslogtreecommitdiffstats
path: root/doc/FileSystem.3
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2012-04-16 06:07:33 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2012-04-16 06:07:33 (GMT)
commit6865953e8f03dca8e223cc63d4a3ca89f0b9b447 (patch)
tree87485cb6588fdd50ea6eabbf57a9939ede163315 /doc/FileSystem.3
parentd234be625eb4be7866809a9b1a58336a9c352794 (diff)
parentc15c9e5f26e373ec9674b39dc42d2c3500c65b5c (diff)
downloadtcl-6865953e8f03dca8e223cc63d4a3ca89f0b9b447.zip
tcl-6865953e8f03dca8e223cc63d4a3ca89f0b9b447.tar.gz
tcl-6865953e8f03dca8e223cc63d4a3ca89f0b9b447.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.
Diffstat (limited to 'doc/FileSystem.3')
-rw-r--r--doc/FileSystem.37
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/FileSystem.3 b/doc/FileSystem.3
index 32407d8..c4a28c2 100644
--- a/doc/FileSystem.3
+++ b/doc/FileSystem.3
@@ -521,7 +521,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.
@@ -1131,8 +1131,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.