summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorjan.nijtmans <nijtmans@users.sourceforge.net>2023-09-11 14:43:41 (GMT)
committerjan.nijtmans <nijtmans@users.sourceforge.net>2023-09-11 14:43:41 (GMT)
commitd01b2d3aceb996995428a82620c6dd47775499bc (patch)
tree4a730a5029bb34a2b4ddfce0960d7ef651583a4f /doc
parent07a1136da5471e4dda4c7ee01757d226692ddaeb (diff)
parenta1319ec00ada091354b870600685140a95aa8184 (diff)
downloadtcl-d01b2d3aceb996995428a82620c6dd47775499bc.zip
tcl-d01b2d3aceb996995428a82620c6dd47775499bc.tar.gz
tcl-d01b2d3aceb996995428a82620c6dd47775499bc.tar.bz2
TIP #666 implementation: Change ptrdiff_t → Tcl_Size in Tcl 8.7 (and 9.0)
Diffstat (limited to 'doc')
-rw-r--r--doc/ByteArrObj.36
-rw-r--r--doc/CrtObjCmd.32
-rw-r--r--doc/CrtTrace.34
-rw-r--r--doc/Number.32
4 files changed, 7 insertions, 7 deletions
diff --git a/doc/ByteArrObj.3 b/doc/ByteArrObj.3
index 639018c..285239d 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 "ptrdiff_t | int" *numBytesPtr out
+.AP "Tcl_Size | 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
-\fBptrdiff_t\fR or of type \fBint\fR. In Tcl 8, the largest number of
+\fBTcl_Size\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 \fBptrdiff_t\fR may aid in the migration.
+of type \fBTcl_Size\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 1481e81..bb63937 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,
- ptrdiff_t \fIobjc\fR,
+ Tcl_Size \fIobjc\fR,
Tcl_Obj *const \fIobjv\fR[]);
.CE
.PP
diff --git a/doc/CrtTrace.3 b/doc/CrtTrace.3
index ba5a991..519f348 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,
- ptrdiff_t \fIlevel\fR,
+ Tcl_Size \fIlevel\fR,
const char *\fIcommand\fR,
\fBTcl_Command\fR \fIcommandToken\fR,
- ptrdiff_t \fIobjc\fR,
+ Tcl_Size \fIobjc\fR,
\fBTcl_Obj\fR *const \fIobjv\fR[]);
.CE
.PP
diff --git a/doc/Number.3 b/doc/Number.3
index d0dbb2f..696dd80 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 ptrdiff_t numBytes in
+.AP Tcl_Size 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.