summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2004-03-23 09:00:57 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2004-03-23 09:00:57 (GMT)
commit82535bcc54c1cbe004c83beec30fc0cc27772fc2 (patch)
treef50ddc8351be9ca459f9b474be2997dc04d523a3
parent21c2e947a4aaead67f9079159dd29cfbc98c74b3 (diff)
downloadtcl-82535bcc54c1cbe004c83beec30fc0cc27772fc2.zip
tcl-82535bcc54c1cbe004c83beec30fc0cc27772fc2.tar.gz
tcl-82535bcc54c1cbe004c83beec30fc0cc27772fc2.tar.bz2
Docfix. [Bug 921464]
-rw-r--r--ChangeLog5
-rw-r--r--doc/StringObj.36
2 files changed, 8 insertions, 3 deletions
diff --git a/ChangeLog b/ChangeLog
index d9799f6..e44c623 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2004-03-23 Donal K. Fellows <donal.k.fellows@man.ac.uk>
+
+ * doc/StringObj.3: Inverted the sense of the documentation of how
+ the bytes parameter is documented to match behaviour. [Bug 921464]
+
2004-03-19 Kevin B. Kenny <kennykb@acm.org>
* compat/strtoll.c:
diff --git a/doc/StringObj.3 b/doc/StringObj.3
index b40cf49..86db898 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.15 2004/03/09 12:59:04 vincentdarley Exp $
+'\" RCS: @(#) $Id: StringObj.3,v 1.16 2004/03/23 09:01:00 dkf Exp $
'\"
.so man.macros
.TH Tcl_StringObj 3 8.1 Tcl "Tcl Library Procedures"
@@ -77,8 +77,8 @@ Tcl_Obj *
.VS 8.1
Points to the first byte of an array of UTF-8-encoded bytes
used to set or append to a string object.
-This byte array should not contain embedded null bytes
-unless \fIlength\fR is negative. (Applications needing null bytes
+This byte array may contain embedded null characters
+unless \fInumChars\fR is negative. (Applications needing null bytes
should represent them as the two-byte sequence \fI\\700\\600\fR, use
\fBTcl_ExternalToUtf\fR to convert, or \fBTcl_NewByteArrayObj\fR if
the string is a collection of uninterpreted bytes.)