[Emacs-diffs] /srv/bzr/emacs/trunk r105837: * lread.c (Fread_from_string): Document what FINAL-STRING-INDEX is.

[Lars Magne Ingebrigtsen]

------------------------------------------------------------
revno: 105837
fixes bug(s): http://debbugs.gnu.org/9493
committer: Lars Magne Ingebrigtsen <address@hidden>
branch nick: trunk
timestamp: Mon 2011-09-19 10:25:35 +0200
message:
  * lread.c (Fread_from_string): Document what FINAL-STRING-INDEX is.
modified:
  src/ChangeLog
  src/lread.c

=== modified file 'src/ChangeLog'
--- a/src/ChangeLog     2011-09-18 20:01:37 +0000
+++ b/src/ChangeLog     2011-09-19 08:25:35 +0000
@@ -1,3 +1,8 @@
+2011-09-19  Lars Magne Ingebrigtsen  <address@hidden>
+
+       * lread.c (Fread_from_string): Document what FINAL-STRING-INDEX is
+       (bug#9493).
+
 2011-09-18  Chong Yidong  <address@hidden>
 
        * xfns.c (Fx_create_frame): Handle the bitmapIcon resource as

=== modified file 'src/lread.c'
--- a/src/lread.c       2011-09-09 01:06:52 +0000
+++ b/src/lread.c       2011-09-19 08:25:35 +0000
@@ -1965,6 +1965,8 @@
 DEFUN ("read-from-string", Fread_from_string, Sread_from_string, 1, 3, 0,
        doc: /* Read one Lisp expression which is represented as text by STRING.
 Returns a cons: (OBJECT-READ . FINAL-STRING-INDEX).
+FINAL-STRING-INDEX is an integer giving the position of the next
+ remaining chararacter in STRING.
 START and END optionally delimit a substring of STRING from which to read;
  they default to 0 and (length STRING) respectively.  */)
   (Lisp_Object string, Lisp_Object start, Lisp_Object end)