From: Glenn Morris <rgm@gnu.org>
Date: Sun, 11 Nov 2012 01:16:25 +0000 (-0800)
Subject: Document debugger-bury-or-kill
X-Git-Tag: emacs-24.2.90~113
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=57fc0fee5fd12dd5b43323d127fea62040c01c79;p=emacs.git

Document debugger-bury-or-kill

* doc/lispref/debugging.texi (Using Debugger): Mention debugger-bury-or-kill.

* lisp/emacs-lisp/debug.el (debugger-bury-or-kill): Doc tweak.

* etc/NEWS: Related edit.
---

diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index 0016258bcb5..9d101722388 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,6 +1,7 @@
 2012-11-11  Glenn Morris  <rgm@gnu.org>
 
 	* debugging.texi (Error Debugging): Mention debug-on-message.
+	(Using Debugger): Mention debugger-bury-or-kill.
 
 	* control.texi (Signaling Errors):
 	* debugging.texi (Error Debugging):
diff --git a/doc/lispref/debugging.texi b/doc/lispref/debugging.texi
index 9a43cfeac5d..11532b19781 100644
--- a/doc/lispref/debugging.texi
+++ b/doc/lispref/debugging.texi
@@ -322,6 +322,7 @@ is a message describing the reason that the debugger was invoked (such
 as the error message and associated data, if it was invoked due to an
 error).
 
+@vindex debugger-bury-or-kill
   The backtrace buffer is read-only and uses a special major mode,
 Debugger mode, in which letters are defined as debugger commands.  The
 usual Emacs editing commands are available; thus, you can switch windows
@@ -330,8 +331,12 @@ switch buffers, visit files, or do any other sort of editing.  However,
 the debugger is a recursive editing level (@pxref{Recursive Editing})
 and it is wise to go back to the backtrace buffer and exit the debugger
 (with the @kbd{q} command) when you are finished with it.  Exiting
-the debugger gets out of the recursive edit and kills the backtrace
-buffer.
+the debugger gets out of the recursive edit and buries the backtrace
+buffer.  (You can customize what the @kbd{q} command does with the
+backtrace buffer by setting the variable @code{debugger-bury-or-kill}.
+For example, set it to @code{kill} if you prefer to kill the buffer
+rather than bury it.  Consult the variable's documentation for more
+possibilities.)
 
   When the debugger has been entered, the @code{debug-on-error}
 variable is temporarily set according to
diff --git a/etc/NEWS b/etc/NEWS
index 42c639ef25b..26707315da6 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -804,7 +804,9 @@ table, but with a different prefix.
 *** New error type and new function `user-error'.
 These do not trigger the debugger.
 
-*** New option `debugger-bury-or-kill'.
++++
+*** New option `debugger-bury-or-kill', saying what to do with the
+debugger buffer when exiting debug.
 
 +++
 *** Set `debug-on-message' to enter the debugger when a certain
diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 0207a4f903f..d7f86f510c5 100644
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,5 +1,7 @@
 2012-11-11  Glenn Morris  <rgm@gnu.org>
 
+	* emacs-lisp/debug.el (debugger-bury-or-kill): Doc tweak.
+
 	* help.el (temp-buffer-max-height):
 	* window.el (fit-frame-to-buffer, fit-frame-to-buffer-bottom-margin):
 	* emacs-lisp/debug.el (debugger-bury-or-kill): Fix :version.
diff --git a/lisp/emacs-lisp/debug.el b/lisp/emacs-lisp/debug.el
index 1117d11e07e..6be30fc9164 100644
--- a/lisp/emacs-lisp/debug.el
+++ b/lisp/emacs-lisp/debug.el
@@ -49,9 +49,9 @@ the middle is discarded, and just the beginning and end are displayed."
   :version "21.1")
 
 (defcustom debugger-bury-or-kill 'bury
-  "How to proceed with the debugger buffer when exiting `debug'.
-The value used here affects the behavior of operations on any
-window previously showing the debugger buffer.
+  "What to do with the debugger buffer when exiting `debug'.
+The value affects the behavior of operations on any window
+previously showing the debugger buffer.
 
 `nil' means that if its window is not deleted when exiting the
   debugger, invoking `switch-to-prev-buffer' will usually show