From be53ecd582bc008f169ae619ccfe2106c401cc04 Mon Sep 17 00:00:00 2001 From: ferrieux Date: Wed, 19 Jan 2011 23:34:15 +0000 Subject: Clarify documentation of format/args checking in Tcl_ObjPrintf. Thanks to Brad Harder (yukonbob). [Bug 3159920] --- doc/StringObj.3 | 7 +++++-- 1 file 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 -- cgit v0.12