guile/guile-core/doc ChangeLog scheme-data.texi...

[Martin Grabmueller]

CVSROOT:        /cvs
Module name:    guile
Changes by:     Martin Grabmueller <address@hidden>     01/05/03 21:57:39

Modified files:
        guile-core/doc : ChangeLog scheme-data.texi scheme-io.texi 

Log message:
        * scheme-io.texi (Block Reading and Writing): Moved the
        documentation for read-string!/partial from the node `Reading'.
        
        * scheme-data.texi (List/String Conversion): Added docstring for
        `string-split'.

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/guile/guile-core/doc/ChangeLog.diff?cvsroot=OldCVS&tr1=1.79&tr2=1.80&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/guile/guile-core/doc/scheme-data.texi.diff?cvsroot=OldCVS&tr1=1.14&tr2=1.15&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/guile/guile-core/doc/scheme-io.texi.diff?cvsroot=OldCVS&tr1=1.11&tr2=1.12&r1=text&r2=text

Patches:
Index: guile/guile-core/doc/ChangeLog
diff -u guile/guile-core/doc/ChangeLog:1.79 guile/guile-core/doc/ChangeLog:1.80
--- guile/guile-core/doc/ChangeLog:1.79 Wed May  2 14:50:15 2001
+++ guile/guile-core/doc/ChangeLog      Thu May  3 21:57:39 2001
@@ -1,3 +1,11 @@
+2001-05-04  Martin Grabmueller  <address@hidden>
+
+       * scheme-io.texi (Block Reading and Writing): Moved the
+       documentation for read-string!/partial from the node `Reading'.
+
+       * scheme-data.texi (List/String Conversion): Added docstring for
+       `string-split'.
+
 2001-05-02  Martin Grabmueller  <address@hidden>
 
        * srfi-13-14.texi: Added @bullet to various @itemize lists.
Index: guile/guile-core/doc/scheme-data.texi
diff -u guile/guile-core/doc/scheme-data.texi:1.14 
guile/guile-core/doc/scheme-data.texi:1.15
--- guile/guile-core/doc/scheme-data.texi:1.14  Sun Apr 22 07:56:52 2001
+++ guile/guile-core/doc/scheme-data.texi       Thu May  3 21:57:39 2001
@@ -1436,6 +1436,27 @@
 concerned.
 @end deffn
 
address@hidden primitive string-split str chr
+Split the string @var{str} into the a list of the substrings delimited
+by appearances of the character @var{chr}.  Note that an empty substring
+between separator characters will result in an empty string in the
+result list.
address@hidden
+(string-split "root:x:0:0:root:/root:/bin/bash" #\:)
address@hidden
+("root" "x" "0" "0" "root" "/root" "/bin/bash")
+
+(string-split "::" #\:)
address@hidden
+("" "" "")
+
+(string-split "" #\:)
address@hidden
+("")
address@hidden lisp
address@hidden deffn
+
+
 @node String Selection
 @subsection String Selection
 
Index: guile/guile-core/doc/scheme-io.texi
diff -u guile/guile-core/doc/scheme-io.texi:1.11 
guile/guile-core/doc/scheme-io.texi:1.12
--- guile/guile-core/doc/scheme-io.texi:1.11    Wed May  2 07:44:38 2001
+++ guile/guile-core/doc/scheme-io.texi Thu May  3 21:57:39 2001
@@ -141,41 +141,6 @@
 current input port if none is specified.
 @end deffn
 
address@hidden primitive read-string!/partial str [port_or_fdes [start [end]]]
-Read characters from an fport or file descriptor into a
-string @var{str}.  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
-read any characters that are currently available,
-without waiting for the rest (short reads are possible).
-
address@hidden
-wait for as long as it needs to for the first character to
-become available, unless the port is in non-blocking mode
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
-
-
 @node Writing
 @section Writing
 
@@ -442,7 +407,39 @@
 the @code{(scsh rw)} module in guile-scsh.
 
 @deffn primitive read-string!/partial str [port_or_fdes] [start] [end]
+Read characters from an fport or file descriptor into a
+string @var{str}.  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
+read any characters that are currently available,
+without waiting for the rest (short reads are possible).
+
address@hidden
+wait for as long as it needs to for the first character to
+become available, unless the port is in non-blocking mode
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
 @end deffn
+
 
 @node Default Ports
 @section Default Ports for Input, Output and Errors