[Guile-commits] 04/10: Undocument (ice-9 rw)

[Andy Wingo]

wingo pushed a commit to branch master
in repository guile.

commit 6eee08874bce2b650f79932e30195369670a2fdd
Author: Andy Wingo <address@hidden>
Date:   Wed Jun 8 08:38:49 2016 +0200

    Undocument (ice-9 rw)
    
    * doc/ref/api-io.texi (Block Reading and Writing): Undocument (ice-9
      rw).  The R6RS routines do the same job and are not so clunky.
---
 doc/ref/api-io.texi |  101 ---------------------------------------------------
 1 file changed, 101 deletions(-)

diff --git a/doc/ref/api-io.texi b/doc/ref/api-io.texi
index 3132045..5c6c213 100644
--- a/doc/ref/api-io.texi
+++ b/doc/ref/api-io.texi
@@ -15,7 +15,6 @@
 * Buffering::                   Controlling when data is written to ports.
 * Random Access::               Moving around a random access port.
 * Line/Delimited::              Read and write lines or delimited text.
-* Block Reading and Writing::   Reading and writing blocks of text.
 * Default Ports::               Defaults for input, output and errors.
 * Port Types::                  Types of port and how to make them.
 * R6RS I/O Ports::              The R6RS port API.
@@ -744,106 +743,6 @@ delimiter may be either a newline or the 
@var{eof-object}; if
 @code{(#<eof> . #<eof>)}.
 @end deffn
 
address@hidden Block Reading and Writing
address@hidden Block reading and writing
address@hidden Block read/write
address@hidden Port, block read/write
-
-The Block-string-I/O module can be accessed with:
-
address@hidden
-(use-modules (ice-9 rw))
address@hidden lisp
-
-It currently contains procedures that help to implement the
address@hidden(scsh rw)} module in guile-scsh.
-
address@hidden {Scheme Procedure} read-string!/partial str [port_or_fdes [start 
[end]]]
address@hidden {C Function} scm_read_string_x_partial (str, port_or_fdes, 
start, end)
-Read characters from a port or file descriptor into a
-string @var{str}.  A port must have an underlying file
-descriptor --- a so-called fport.  This procedure is
-scsh-compatible and can efficiently read large strings.
-It will:
-
address@hidden
address@hidden
-attempt to fill the entire string, unless the @var{start}
-and/or @var{end} arguments are supplied.  i.e., @var{start}
-defaults to 0 and @var{end} defaults to
address@hidden(string-length str)}
address@hidden
-use the current input port if @var{port_or_fdes} is not
-supplied.
address@hidden
-return fewer than the requested number of characters in some
-cases, e.g., on end of file, if interrupted by a signal, or if
-not all the characters are immediately available.
address@hidden
-wait indefinitely for some input if no characters are
-currently available,
-unless the port is in non-blocking mode.
address@hidden
-read characters from the port's input buffers if available,
-instead from the underlying file descriptor.
address@hidden
-return @code{#f} if end-of-file is encountered before reading
-any characters, otherwise return the number of characters
-read.
address@hidden
-return 0 if the port is in non-blocking mode and no characters
-are immediately available.
address@hidden
-return 0 if the request is for 0 bytes, with no
-end-of-file check.
address@hidden itemize
address@hidden deffn
-
address@hidden {Scheme Procedure} write-string/partial str [port_or_fdes [start 
[end]]]
address@hidden {C Function} scm_write_string_partial (str, port_or_fdes, start, 
end)
-Write characters from a string @var{str} to a port or file
-descriptor.  A port must have an underlying file descriptor
---- a so-called fport.  This procedure is
-scsh-compatible and can efficiently write large strings.
-It will:
-
address@hidden
address@hidden
-attempt to write the entire string, unless the @var{start}
-and/or @var{end} arguments are supplied.  i.e., @var{start}
-defaults to 0 and @var{end} defaults to
address@hidden(string-length str)}
address@hidden
-use the current output port if @var{port_of_fdes} is not
-supplied.
address@hidden
-in the case of a buffered port, store the characters in the
-port's output buffer, if all will fit.  If they will not fit
-then any existing buffered characters will be flushed
-before attempting
-to write the new characters directly to the underlying file
-descriptor.  If the port is in non-blocking mode and
-buffered characters can not be flushed immediately, then an
address@hidden system-error exception will be raised (Note:
-scsh does not support the use of non-blocking buffered ports.)
address@hidden
-write fewer than the requested number of
-characters in some cases, e.g., if interrupted by a signal or
-if not all of the output can be accepted immediately.
address@hidden
-wait indefinitely for at least one character
-from @var{str} to be accepted by the port, unless the port is
-in non-blocking mode.
address@hidden
-return the number of characters accepted by the port.
address@hidden
-return 0 if the port is in non-blocking mode and can not accept
-at least one character from @var{str} immediately
address@hidden
-return 0 immediately if the request size is 0 bytes.
address@hidden itemize
address@hidden deffn
-
 @node Default Ports
 @subsection Default Ports for Input, Output and Errors
 @cindex Default ports