From 02eaab2e8eaad86dabf732b37ae416f9000e05a0 Mon Sep 17 00:00:00 2001
From: rtoy <rtoy>
Date: Wed, 8 Sep 2010 02:58:06 +0000
Subject: [PATCH] Correct docstring for OCTETS-TO-STRING to reflect what
 actually happens.

---
 code/extfmts.lisp | 12 +++++++-----
 1 file changed, 7 insertions(+), 5 deletions(-)

diff --git a/code/extfmts.lisp b/code/extfmts.lisp
index 60378d718..b408586da 100644
--- a/code/extfmts.lisp
+++ b/code/extfmts.lisp
@@ -5,7 +5,7 @@
 ;;; domain.
 ;;; 
 (ext:file-comment
- "$Header: /Volumes/share2/src/cmucl/cvs2git/cvsroot/src/code/extfmts.lisp,v 1.40 2010/09/06 19:01:56 rtoy Exp $")
+ "$Header: /Volumes/share2/src/cmucl/cvs2git/cvsroot/src/code/extfmts.lisp,v 1.41 2010/09/08 02:58:06 rtoy Rel $")
 ;;;
 ;;; **********************************************************************
 ;;;
@@ -921,11 +921,13 @@ character and illegal outputs are replaced by a question mark.")
   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.
+  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 number of characters read,
-  the number of octets actually consumed and the new state of the
-  external format."
+  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)
-- 
GitLab