summaryrefslogtreecommitdiffstats
path: root/doc/StringObj.3
diff options
context:
space:
mode:
authorjan.nijtmans <nijtmans@users.sourceforge.net>2023-11-12 16:51:03 (GMT)
committerjan.nijtmans <nijtmans@users.sourceforge.net>2023-11-12 16:51:03 (GMT)
commit65d7ec626d98c3b3143917119c49bd55c2c2bbe4 (patch)
treed5e85e38010055de676fd07dda881c44b18ea925 /doc/StringObj.3
parent716a20f7e5a0600f4cd4a7faff07ae2fef468b0d (diff)
parentfb02c7f0083f3e1c4a07119b5003c6eaa4dd05f7 (diff)
downloadtcl-65d7ec626d98c3b3143917119c49bd55c2c2bbe4.zip
tcl-65d7ec626d98c3b3143917119c49bd55c2c2bbe4.tar.gz
tcl-65d7ec626d98c3b3143917119c49bd55c2c2bbe4.tar.bz2
TIP #664: Enable compiler warnings for missing int → Tcl_Size conversions
Diffstat (limited to 'doc/StringObj.3')
-rw-r--r--doc/StringObj.35
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/StringObj.3 b/doc/StringObj.3
index 28caae7..0da0e43 100644
--- a/doc/StringObj.3
+++ b/doc/StringObj.3
@@ -120,7 +120,10 @@ A pointer to a value to read, or to an unshared value to modify.
The value to append to \fIobjPtr\fR in \fBTcl_AppendObjToObj\fR.
.AP "Tcl_Size \&| int" *lengthPtr out
The location where \fBTcl_GetStringFromObj\fR will store the length
-of a value's string representation. May be (int *)NULL when not used.
+of a value's string representation. May be (Tcl_Size *)NULL when not used. If it points to a variable which
+type is not \fBTcl_Size\fR, a compiler warning will be generated, in
+order to indicate that when the string is larger than INT_MAX
+this function will panic.
.AP "const char" *string in
Null-terminated string value to append to \fIobjPtr\fR.
.AP Tcl_Size limit in