summaryrefslogtreecommitdiff
path: root/doc/ref/scheme-io.texi
diff options
context:
space:
mode:
authorNeil Jerram <neil@ossau.uklinux.net>2002-10-19 16:33:25 +0000
committerNeil Jerram <neil@ossau.uklinux.net>2002-10-19 16:33:25 +0000
commit0a50eeaadb3533ad57ebe26f91cc750e1dadc809 (patch)
tree02695bc70d98de816fd46e849b67bcbdb3a1bdfb /doc/ref/scheme-io.texi
parent5ec1d2c8e04ebaa909e8064a80ffc76620143bcf (diff)
downloadguile-0a50eeaadb3533ad57ebe26f91cc750e1dadc809.tar.gz
Auto docstring updates, including soft port enhancement.
Diffstat (limited to 'doc/ref/scheme-io.texi')
-rw-r--r--doc/ref/scheme-io.texi5
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/ref/scheme-io.texi b/doc/ref/scheme-io.texi
index 3df790051..b4a288fbc 100644
--- a/doc/ref/scheme-io.texi
+++ b/doc/ref/scheme-io.texi
@@ -839,7 +839,7 @@ accepting or delivering characters. It allows emulation of I/O ports.
@deffnx {C Function} scm_make_soft_port (pv, modes)
Return a port capable of receiving or delivering characters as
specified by the @var{modes} string (@pxref{File Ports,
-open-file}). @var{pv} must be a vector of length 5. Its
+open-file}). @var{pv} must be a vector of length 5 or 6. Its
components are as follows:
@enumerate 0
@@ -853,6 +853,9 @@ thunk for flushing output
thunk for getting one character
@item
thunk for closing port (not by garbage collection)
+@item
+(if present and not @code{#f}) thunk for computing the number of
+characters that can be read from the port without blocking.
@end enumerate
For an output-only port only elements 0, 1, 2, and 4 need be