From 4c6600039e95879fea2b3e5715592473edbd05e8 Mon Sep 17 00:00:00 2001 From: apnadkarni Date: Wed, 19 Apr 2023 05:49:37 +0000 Subject: Fix a few function signatures in manpages for TIP 660. --- doc/ByteArrObj.3 | 6 +++--- doc/CrtObjCmd.3 | 2 +- doc/CrtTrace.3 | 4 ++-- doc/Number.3 | 2 +- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/ByteArrObj.3 b/doc/ByteArrObj.3 index fd7f245..639018c 100644 --- a/doc/ByteArrObj.3 +++ b/doc/ByteArrObj.3 @@ -43,7 +43,7 @@ overwritten by a byte-array value. For \fBTcl_GetBytesFromObj\fR, to the value from which to extract an array of bytes. .AP Tcl_Interp *interp in Interpreter to use for error reporting. -.AP "size_t | int" *numBytesPtr out +.AP "ptrdiff_t | int" *numBytesPtr out Points to space where the number of bytes in the array may be written. Caller may pass NULL when it does not need this information. .BE @@ -154,10 +154,10 @@ and any string representation is invalidated. On success, both \fBTcl_GetBytesFromObj\fR and \fBTcl_GetByteArrayFromObj\fR write the number of bytes in the byte-array value of \fIobjPtr\fR to the space pointed to by \fInumBytesPtr\fR. This space may be of type -\fBsize_t\fR or of type \fBint\fR. In Tcl 8, the largest number of +\fBptrdiff_t\fR or of type \fBint\fR. In Tcl 8, the largest number of bytes possible is \fBINT_MAX\fR, so either type can receive the value. In codebases meant to migrate to Tcl 9, the option to write to a space -of type \fBsize_t\fR may aid in the migration. +of type \fBptrdiff_t\fR may aid in the migration. .PP \fBTcl_SetByteArrayLength\fR enables a caller to change the size of a byte-array in the internal representation of an unshared \fIobjPtr\fR to diff --git a/doc/CrtObjCmd.3 b/doc/CrtObjCmd.3 index 0490bd7..1481e81 100644 --- a/doc/CrtObjCmd.3 +++ b/doc/CrtObjCmd.3 @@ -187,7 +187,7 @@ except its \fIproc2\fR argument is of type \fBTcl_ObjCmdProc2\fR. typedef int \fBTcl_ObjCmdProc2\fR( ClientData \fIclientData\fR, Tcl_Interp *\fIinterp\fR, - size_t \fIobjc\fR, + ptrdiff_t \fIobjc\fR, Tcl_Obj *const \fIobjv\fR[]); .CE .PP diff --git a/doc/CrtTrace.3 b/doc/CrtTrace.3 index 723a392..ba5a991 100644 --- a/doc/CrtTrace.3 +++ b/doc/CrtTrace.3 @@ -88,10 +88,10 @@ typedef int \fBTcl_CmdObjTraceProc\fR( typedef int \fBTcl_CmdObjTraceProc2\fR( \fBvoid *\fR \fIclientData\fR, \fBTcl_Interp\fR* \fIinterp\fR, - size_t \fIlevel\fR, + ptrdiff_t \fIlevel\fR, const char *\fIcommand\fR, \fBTcl_Command\fR \fIcommandToken\fR, - size_t \fIobjc\fR, + ptrdiff_t \fIobjc\fR, \fBTcl_Obj\fR *const \fIobjv\fR[]); .CE .PP diff --git a/doc/Number.3 b/doc/Number.3 index f405060..d0dbb2f 100644 --- a/doc/Number.3 +++ b/doc/Number.3 @@ -27,7 +27,7 @@ When non-NULL, error information is recorded here when the value is not in any of the numeric formats recognized by Tcl. .AP "const char" *bytes in Points to first byte of the string value to be examined. -.AP size_t numBytes in +.AP ptrdiff_t numBytes in The number of bytes, starting at \fIbytes\fR, that should be examined. If the value \fBTCL_INDEX_NONE\fR is provided, then all bytes should be examined until the first \fBNUL\fR byte terminates examination. -- cgit v0.12