[cmucl-commit] [git] CMU Common Lisp branch master updated. snapshot-2012-02-11-gd9a51ad

[Raymond Toy]

This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "CMU Common Lisp".

The branch, master has been updated
       via  d9a51ad03487c82a9d5998c1b2b4490447141b76 (commit)
      from  2997c7c834786873ea24e70ce9e45dc80f0ae8f8 (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
commit d9a51ad03487c82a9d5998c1b2b4490447141b76
Author: Raymond Toy <toy.raymond at gmail.com>
Date:   Sat Feb 11 09:40:23 2012 -0800

    Update documentation for string-to-octets.

diff --git a/src/docs/cmu-user/unicode.tex b/src/docs/cmu-user/unicode.tex
index 916c9dc..921a40d 100644
--- a/src/docs/cmu-user/unicode.tex
+++ b/src/docs/cmu-user/unicode.tex
@@ -560,15 +560,31 @@ utility functions are provided to make access easier.
 \end{defun}
 
 \begin{defun}{}{string-to-octets}{\args \var{string} \keys{\kwd{start}
-      \kwd{end} \kwd{external-format} \kwd{buffer}}}
+      \kwd{end} \kwd{external-format} \kwd{buffer} \kwd{buffer-start}
+      \kwd{error}}}
   \code{string-to-octets} converts \var{string} to a sequence of
   octets according to the external format specified by
   \var{external-format}.  The string to be converted is bounded by
   \var{start}, which defaults to 0, and \var{end}, which defaults to
   the length of the string.  If \var{buffer} is specified, the octets
   are placed in \var{buffer}.  If \var{buffer} is not specified, a new
-  array is allocated to hold the octets.  In all cases the buffer is
-  returned.
+  array is allocated to hold the octets.  \var{buffer-start} specifies
+  where in the buffer the first octet will be placed.
+
+  An error method may also be specified by \var{error}.  Any errors
+  encountered while converting the string to octets will be handled
+  according to error.  If \nil{}, a replacement character is converted
+  to octets in place of the error.  Otherwise, \var{error} should be a
+  symbol or function that will be called when the error occurs.  The
+  function takes two arguments:  an error string and the character
+  that caused the error.  It should return a replacement character.
+  
+  Three values are returned: The buffer, the number of valid octets
+  written, and the number of characters converted.  Note that the
+  actual number of octets written may be greater than the returned
+  value, These represent the partial octets of the next character to
+  be converted, but there was not enough room to hold the complete set
+  of octets.
 \end{defun}
 
 \begin{defun}{}{octets-to-string}{\args \var{octets} \keys{\kwd{start}

-----------------------------------------------------------------------

Summary of changes:
 src/docs/cmu-user/unicode.tex |   22 +++++++++++++++++++---
 1 files changed, 19 insertions(+), 3 deletions(-)


hooks/post-receive
-- 
CMU Common Lisp