[Emacs-diffs] /srv/bzr/emacs/trunk r107101: Document debug-on-event

[Glenn Morris]

------------------------------------------------------------
revno: 107101
committer: Glenn Morris <address@hidden>
branch nick: trunk
timestamp: Sat 2012-02-04 13:58:00 -0800
message:
  Document debug-on-event
  
  * doc/lispref/debugging.texi (Error Debugging): Mention debug-on-event.
  * doc/lispref/commands.texi (Misc Events): Mention sigusr1,2 and debugging.
  * etc/NEWS: Related edit.
modified:
  doc/lispref/ChangeLog
  doc/lispref/commands.texi
  doc/lispref/debugging.texi
  etc/NEWS

=== modified file 'doc/lispref/ChangeLog'
--- a/doc/lispref/ChangeLog     2012-02-04 20:59:54 +0000
+++ b/doc/lispref/ChangeLog     2012-02-04 21:58:00 +0000
@@ -1,5 +1,8 @@
 2012-02-04  Glenn Morris  <address@hidden>
 
+       * debugging.texi (Error Debugging): Mention debug-on-event.
+       * commands.texi (Misc Events): Mention sigusr1,2 and debugging.
+
        * modes.texi (Running Hooks): Try to clarify with-wrapper-hook.
 
        * text.texi (Buffer Contents):

=== modified file 'doc/lispref/commands.texi'
--- a/doc/lispref/commands.texi 2012-02-02 07:06:37 +0000
+++ b/doc/lispref/commands.texi 2012-02-04 21:58:00 +0000
@@ -1696,6 +1696,7 @@
 These events are generated when the Emacs process receives
 the signals @code{SIGUSR1} and @code{SIGUSR2}.  They contain no
 additional data because signals do not carry additional information.
+They can be useful for debugging (@pxref{Error Debugging}).
 
 To catch a user signal, bind the corresponding event to an interactive
 command in the @code{special-event-map} (@pxref{Active Keymaps}).

=== modified file 'doc/lispref/debugging.texi'
--- a/doc/lispref/debugging.texi        2012-01-19 07:21:25 +0000
+++ b/doc/lispref/debugging.texi        2012-02-04 21:58:00 +0000
@@ -148,6 +148,15 @@
 @code{debug-on-error} is @code{nil}.
 @end defopt
 
address@hidden debug-on-event
+If you set @code{debug-on-event} to a special event (@pxref{Special
+Events}), Emacs will try to enter the debugger as soon as it receives
+this event, bypassing @code{special-event-map}.  At present, the only
+supported values correspond to the signals @code{SIGUSR1} and
address@hidden  This can be helpful when @code{inhibit-quit} is set
+and Emacs is not otherwise responding.
address@hidden defopt
+
   To debug an error that happens during loading of the init
 file, use the option @samp{--debug-init}.  This binds
 @code{debug-on-error} to @code{t} while loading the init file, and

=== modified file 'etc/NEWS'
--- a/etc/NEWS  2012-02-04 21:48:04 +0000
+++ b/etc/NEWS  2012-02-04 21:58:00 +0000
@@ -1403,7 +1403,9 @@
 
 ** keymaps can inherit from multiple parents.
 
-** `debug-on-event' lets you debug Emacs when stuck because of inhibit-quit.
++++
+** Set `debug-on-event' to make Emacs enter the debugger e.g. on receipt
+of SIGUSR1.  This can be useful when `inhibit-quit' is set.
 
 +++
 ** New reader macro ## which stands for the empty symbol.