summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2013-01-03 14:24:48 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2013-01-03 14:24:48 (GMT)
commit96dcdfe7ee3f9197034b7488545e57fcf22826dd (patch)
treeb16e087a22c2bc0812fb082b32091f975ffab851
parent8e375b451619f7f100356e82983143a1546f1758 (diff)
downloadtcl-96dcdfe7ee3f9197034b7488545e57fcf22826dd.zip
tcl-96dcdfe7ee3f9197034b7488545e57fcf22826dd.tar.gz
tcl-96dcdfe7ee3f9197034b7488545e57fcf22826dd.tar.bz2
Channel buffer min size is 1. Issue found by Schelte Bron.
-rw-r--r--ChangeLog4
-rw-r--r--doc/CrtChannel.32
-rw-r--r--doc/fconfigure.n4
3 files changed, 7 insertions, 3 deletions
diff --git a/ChangeLog b/ChangeLog
index 09a0199..93cf3a2 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,9 @@
2013-01-03 Donal K. Fellows <dkf@users.sf.net>
+ * doc/fconfigure.n, doc/CrtChannel.3: Updated to reflect the fact that
+ the minimum buffer size is one byte, not ten. Identified by Schelte
+ Bron on the Tcler's Chat.
+
* generic/tclExecute.c (TEBCresume:INST_INVOKE_REPLACE):
* generic/tclEnsemble.c (TclCompileEnsemble): Added new mechanism to
allow for more efficient dispatch of non-bytecode-compiled subcommands
diff --git a/doc/CrtChannel.3 b/doc/CrtChannel.3
index 55a4024..4e22488 100644
--- a/doc/CrtChannel.3
+++ b/doc/CrtChannel.3
@@ -250,7 +250,7 @@ the default value of 4096 is returned.
.PP
\fBTcl_SetChannelBufferSize\fR sets the size, in bytes, of buffers that
will be allocated in subsequent operations on the channel to store input or
-output. The \fIsize\fR argument should be between ten and one million,
+output. The \fIsize\fR argument should be between one and one million,
allowing buffers of ten bytes to one million bytes. If \fIsize\fR is
outside this range, \fBTcl_SetChannelBufferSize\fR sets the buffer size to
4096.
diff --git a/doc/fconfigure.n b/doc/fconfigure.n
index ac0366c..550d071 100644
--- a/doc/fconfigure.n
+++ b/doc/fconfigure.n
@@ -72,8 +72,8 @@ initially set to \fBline\fR, and \fBstderr\fR is set to \fBnone\fR.
.
\fINewvalue\fR must be an integer; its value is used to set the size of
buffers, in bytes, subsequently allocated for this channel to store input
-or output. \fINewvalue\fR must be between ten and one million, allowing
-buffers of ten to one million bytes in size.
+or output. \fINewvalue\fR must be between one and one million, allowing
+buffers of one to one million bytes in size.
.TP
\fB\-encoding\fR \fIname\fR
.