Tcl Source Code

View Ticket
Login
Ticket UUID: 1f1b1686268813f2db7da60e96980a1c750d0c99
Title: Tcl 9 StringObj.3 - lengthPtr not documented
Type: Bug Created on: 2023-01-27 16:37:24
Submitter: pointsman Assigned to: jan.nijtmans
Subsystem: 69. Other Severity: Minor
Priority: 5 Medium Last modified: 2023-01-27 22:58:44
Status: Open Closed by: nobody
Resolution: None Closed on:
Version:
Description:
StringObj.3 documents amongst others the API funktions 

Tcl_GetStringFromObj(objPtr, lengthPtr)

Tcl_GetUnicodeFromObj(objPtr, lengthPtr)

The argument lengthPtr isn't documented as all the other arguments (and in the Tcl 8 version of the man page). 

Obviously an oversight/mistake. Should be added, since just the type of that argument changed in Tcl 9.
User Comments:

pointsman added on 2023-01-27 22:58:44:
Ah, then this perhaps an markup / formating error.

If I look at the StringObj.3 man page on a debian 11.6 in the doc directory with

man -l StringObj.3

then I see

       size_t | (int)                                The    location     where
                                                     Tcl_GetStringFromObj will
                                                     store  the  length  of  a
                                                     value's  string represen‐
                                                     tation.   May   be   (int
                                                     *)NULL when not used.


I missed initially because I searched for "lengthPtr".

For me on that box (with man version 2.9.4) I don't see "lengtPtr (out)" which is indeed in the man page source code.