Menu ▾ ▴

#5021 documentation for OPENFILECHANNELPROC may lead to bugs

obsolete: 8.4.19
closed-fixed
Donal K. Fellows
37. File System (341)
5
2012-04-16
2012-04-15
Christophe
No

Hello,

At current time, the section in the man page about the FileSystem's callback function "openFileChannelProc" can lead to bugs, as the paragraph suggests we should register the channel in the interpreter with "RegisterChannel"; this is not the case as this can lead to crash in some use cases ("called Tcl_Close on channel with refCount > 0"), and the TclLib's function "Tcl_FSOpenFileChannel" states that this has to be done by its caller.

I propose the attached patch to the man page to remove the possible misunderstanding.

Discussion

  • Christophe

    Christophe - 2012-04-15

    openFileChannelProc.patch - FileSystem man page change

     
    openFileChannelProc.patch

  • Donal K. Fellows

    Donal K. Fellows - 2012-04-16

    Needed fixing in all three main branches. Thanks for pointing this out.

     

  • Donal K. Fellows

    Donal K. Fellows - 2012-04-16
    • milestone: 2361739 --> obsolete: 8.4.19
    • assigned_to: vincentdarley --> dkf
    • status: open --> closed-fixed