summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorferrieux <ferrieux@users.sourceforge.net>2011-01-19 23:34:15 (GMT)
committerferrieux <ferrieux@users.sourceforge.net>2011-01-19 23:34:15 (GMT)
commitbe53ecd582bc008f169ae619ccfe2106c401cc04 (patch)
treeb76ca77336a618672abbef89c0c880bf574e51ce /doc
parent3303939db5a5fbd9104a93d8281ec09d2eef0d37 (diff)
downloadtcl-be53ecd582bc008f169ae619ccfe2106c401cc04.zip
tcl-be53ecd582bc008f169ae619ccfe2106c401cc04.tar.gz
tcl-be53ecd582bc008f169ae619ccfe2106c401cc04.tar.bz2
Clarify documentation of format/args checking in Tcl_ObjPrintf. Thanks to Brad Harder (yukonbob). [Bug 3159920]
Diffstat (limited to 'doc')
-rw-r--r--doc/StringObj.37
1 files changed, 5 insertions, 2 deletions
diff --git a/doc/StringObj.3 b/doc/StringObj.3
index 8091e2b..38e5857 100644
--- a/doc/StringObj.3
+++ b/doc/StringObj.3
@@ -4,7 +4,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: StringObj.3,v 1.31 2009/04/10 13:14:38 dkf Exp $
+'\" RCS: @(#) $Id: StringObj.3,v 1.32 2011/01/19 23:34:15 ferrieux Exp $
'\"
.so man.macros
.TH Tcl_StringObj 3 8.1 Tcl "Tcl Library Procedures"
@@ -330,7 +330,10 @@ Tcl_Obj *objPtr = \fBTcl_ObjPrintf\fR("Value is %d", x);
.PP
If the value of \fIformat\fR contains internal inconsistencies or invalid
specifier formats, the formatted string result produced by
-\fBTcl_ObjPrintf\fR will be an error message describing the error.
+\fBTcl_ObjPrintf\fR will be an error message describing the error.
+It is impossible however to provide runtime protection against
+mismatches between the format and any subsequent arguments.
+Compile-time protection may be provided by some compilers.
.PP
\fBTcl_AppendPrintfToObj\fR is an appending alternative form
of \fBTcl_ObjPrintf\fR with functionality equivalent to