diff options
| author | donal.k.fellows@manchester.ac.uk <dkf> | 2012-04-16 06:15:09 (GMT) |
|---|---|---|
| committer | donal.k.fellows@manchester.ac.uk <dkf> | 2012-04-16 06:15:09 (GMT) |
| commit | f8aac8194080abfbed0df75db2cd70f7ceb95a53 (patch) | |
| tree | bc271d77fbd11a554314f35a3faba2c42c7137ff /doc/FileSystem.3 | |
| parent | eaef5fbfeb7555b000603b9686324ece9a94d960 (diff) | |
| parent | 1b1cb9b8d72d69e9df892d7b5d26493d7827ef1a (diff) | |
| download | tcl-f8aac8194080abfbed0df75db2cd70f7ceb95a53.zip tcl-f8aac8194080abfbed0df75db2cd70f7ceb95a53.tar.gz tcl-f8aac8194080abfbed0df75db2cd70f7ceb95a53.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.3 | 7 |
1 files changed, 4 insertions, 3 deletions
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. |