CMUCL commit: src/code (extfmts.lisp)

[Raymond Toy]

    Date: Tuesday, September 7, 2010 @ 22:58:06
  Author: rtoy
    Path: /project/cmucl/cvsroot/src/code

Modified: extfmts.lisp

Correct docstring for OCTETS-TO-STRING to reflect what actually
happens.


--------------+
 extfmts.lisp |   14 ++++++++------
 1 file changed, 8 insertions(+), 6 deletions(-)


Index: src/code/extfmts.lisp
diff -u src/code/extfmts.lisp:1.40 src/code/extfmts.lisp:1.41
--- src/code/extfmts.lisp:1.40	Mon Sep  6 15:01:56 2010
+++ src/code/extfmts.lisp	Tue Sep  7 22:58:06 2010
@@ -5,7 +5,7 @@
 ;;; domain.
 ;;; 
 (ext:file-comment
- "$Header: /project/cmucl/cvsroot/src/code/extfmts.lisp,v 1.40 2010-09-06 19:01:56 rtoy Exp $")
+ "$Header: /project/cmucl/cvsroot/src/code/extfmts.lisp,v 1.41 2010-09-08 02:58:06 rtoy Exp $")
 ;;;
 ;;; **********************************************************************
 ;;;
@@ -921,11 +921,13 @@
   the length of String).  If the string is not large enough to hold
   all of characters, then some octets will not be converted.  A State
   may also be specified; this is used as the state of the external
-  format.
-
-  Four values are returned: the string, the number of characters read,
-  the number of octets actually consumed and the new state of the
-  external format."
+  format.  An error method may also be specified by Error, which
+  defaults to NIL to mean the default handling of conversion errors is
+  done.
+
+  Four values are returned: the string, the position of where the next
+  character would be read into the string, the number of octets
+  actually consumed and the new state of the external format."
   (declare (type (simple-array (unsigned-byte 8) (*)) octets)
 	   (type kernel:index start s-start)
 	   (type (or kernel:index null) end)