* keyboard.c (Frecursive_edit): Say more precicely how throwing `exit' works.

Fixes: debbugs:15865

diff --git a/src/ChangeLog b/src/ChangeLog
index a056eead1f64760697203dc0284455007d8f3d94..d55549891907f8955da112b39a055561760e1520 100644 (file)
--- a/src/ChangeLog
+++ b/src/ChangeLog
@@ -1,3 +1,8 @@
+2014-02-08  Lars Ingebrigtsen  <larsi@gnus.org>
+
+       * keyboard.c (Frecursive_edit): Say more precicely how throwing
+       `exit' works (bug#15865).
+
 2014-02-07  Martin Rudalics  <rudalics@gmx.at>
 
        Constrain window box/body sizes and margin widths (Bug#16649).

diff --git a/src/keyboard.c b/src/keyboard.c
index 1914dca0ba530df47bf897715d3e3649a758143d..52bb50800df4e6a6a03ef0a37a38d2f1e16ec2ea 100644 (file)
--- a/src/keyboard.c
+++ b/src/keyboard.c
@@ -807,9 +807,13 @@ force_auto_save_soon (void)
 \f
 DEFUN ("recursive-edit", Frecursive_edit, Srecursive_edit, 0, 0, "",
        doc: /* Invoke the editor command loop recursively.
-To get out of the recursive edit, a command can do `(throw 'exit nil)';
-that tells this function to return.
-Alternatively, `(throw 'exit t)' makes this function signal an error.
+To get out of the recursive edit, a command can throw to `exit' -- for
+instance `(throw 'exit nil)'.
+If you throw a value other than t, `recursive-edit' returns normally
+to the function that called it.  Throwing a t value causes
+`recursive-edit' to quit, so that control returns to the command loop
+one level up
+
 This function is called by the editor initialization to begin editing.  */)
   (void)
 {