[Emacs-diffs] trunk r116317: * keyboard.c (Frecursive_edit): Say more precicely how throwing `exit' works.

[Lars Ingebrigtsen]

------------------------------------------------------------
revno: 116317
revision-id: address@hidden
parent: address@hidden
fixes bug: http://debbugs.gnu.org/15865
committer: Lars Ingebrigtsen <address@hidden>
branch nick: trunk
timestamp: Fri 2014-02-07 19:29:47 -0800
message:
  * keyboard.c (Frecursive_edit): Say more precicely how throwing `exit' works.
modified:
  src/ChangeLog                  changelog-20091113204419-o5vbwnq5f7feedwu-1438
  src/keyboard.c                 keyboard.c-20091113204419-o5vbwnq5f7feedwu-449

=== modified file 'src/ChangeLog'
--- a/src/ChangeLog     2014-02-07 10:55:28 +0000
+++ b/src/ChangeLog     2014-02-08 03:29:47 +0000
@@ -1,3 +1,8 @@
+2014-02-08  Lars Ingebrigtsen  <address@hidden>
+
+       * keyboard.c (Frecursive_edit): Say more precicely how throwing
+       `exit' works (bug#15865).
+
 2014-02-07  Martin Rudalics  <address@hidden>
 
        Constrain window box/body sizes and margin widths (Bug#16649).

=== modified file 'src/keyboard.c'
--- a/src/keyboard.c    2014-02-06 18:29:57 +0000
+++ b/src/keyboard.c    2014-02-08 03:29:47 +0000
@@ -807,9 +807,13 @@
 
 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)
 {