* lread.c (Fread_from_string): Document what FINAL-STRING-INDEX is.

Fixes: debbugs:9493

diff --git a/src/ChangeLog b/src/ChangeLog
index 8c223cc..12a4591 100644 (file)
--- a/src/ChangeLog
+++ b/src/ChangeLog
@@ -1,3 +1,8 @@
+2011-09-19  Lars Magne Ingebrigtsen  <larsi@gnus.org>
+
+       * lread.c (Fread_from_string): Document what FINAL-STRING-INDEX is
+       (bug#9493).
+
 2011-09-18  Chong Yidong  <cyd@stupidchicken.com>
 
        * xfns.c (Fx_create_frame): Handle the bitmapIcon resource as

diff --git a/src/lread.c b/src/lread.c
index 11c4cf8..2b1b49a 100644 (file)
--- a/src/lread.c
+++ b/src/lread.c
@@ -1965,6 +1965,8 @@ STREAM or the value of `standard-input' may be:
 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)