Commit 7aa5aad8 authored by Glenn Morris's avatar Glenn Morris

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.
parent 1f5e1a16
2012-02-04 Glenn Morris <>
* 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):
......@@ -1696,6 +1696,7 @@ parameters are used to display the help-echo text are described in
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}).
......@@ -146,6 +146,15 @@ enter the debugger.
@strong{Warning:} @code{debug-on-signal} has no effect when
@code{debug-on-error} is @code{nil}.
@end defopt
@defopt 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
@code{SIGUSR2}. This can be helpful when @code{inhibit-quit} is set
and Emacs is not otherwise responding.
@end defopt
To debug an error that happens during loading of the init
......@@ -1403,7 +1403,9 @@ as well as those in the -*- line.
** 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.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment