procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve doc strings of several variables in keyboard.c

Browse source 
* src/keyboard.c (syms_of_keyboard) <debug-on-event>
<attempt-stack-overflow-recovery>
<attempt-orderly-shutdown-on-fatal-signal>: Make sure the first
sentence of the doc string fits on a single line.
This commit is contained in:
Eli Zaretskii 2018-07-21 12:28:11 +03:00
parent 61de292c72
commit 7308fa0e2b
1 changed files with 15 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

28
src/keyboard.c
View file

@ -11854,10 +11854,10 @@ if the command is in this list, the selection is not updated. */);
DEFVAR_LISP ("debug-on-event", DEFVAR_LISP ("debug-on-event",
Vdebug_on_event, Vdebug_on_event,
doc: /* Enter debugger on this event. When Emacs doc: /* Enter debugger on this event.
receives the special event specified by this variable, it will try to When Emacs receives the special event specified by this variable,
break into the debugger as soon as possible instead of processing the it will try to break into the debugger as soon as possible instead
event normally through `special-event-map'. of processing the event normally through `special-event-map'.
Currently, the only supported values for this Currently, the only supported values for this
variable are `sigusr1' and `sigusr2'. */); variable are `sigusr1' and `sigusr2'. */);
@ -11865,21 +11865,23 @@ variable are `sigusr1' and `sigusr2'. */);
DEFVAR_BOOL ("attempt-stack-overflow-recovery", DEFVAR_BOOL ("attempt-stack-overflow-recovery",
attempt_stack_overflow_recovery, attempt_stack_overflow_recovery,
doc: /* If non-nil, attempt to recover from C stack doc: /* If non-nil, attempt to recover from C stack overflows.
overflow. This recovery is unsafe and may lead to deadlocks or data This recovery is potentially unsafe and may lead to deadlocks or data
corruption, but it usually works and may preserve modified buffers corruption, but it usually works and may preserve modified buffers
that would otherwise be lost. If nil, treat stack overflow like any that would otherwise be lost. If nil, treat stack overflow like any
other kind of crash. */); other kind of crash or fatal error. */);
attempt_stack_overflow_recovery = true; attempt_stack_overflow_recovery = true;
DEFVAR_BOOL ("attempt-orderly-shutdown-on-fatal-signal", DEFVAR_BOOL ("attempt-orderly-shutdown-on-fatal-signal",
attempt_orderly_shutdown_on_fatal_signal, attempt_orderly_shutdown_on_fatal_signal,
doc: /* If non-nil, attempt to perform an orderly doc: /* If non-nil, attempt orderly shutdown on fatal signals.
shutdown when Emacs receives a fatal signal (e.g., a crash). By default this variable is non-nil, and Emacs attempts to perform
This cleanup is unsafe and may lead to deadlocks or data corruption, an orderly shutdown when it catches a fatal signal (e.g., a crash).
but it usually works and may preserve modified buffers that would The orderly shutdown includes an attempt to auto-save your unsaved edits
otherwise be lost. If nil, crash immediately in response to fatal and other useful cleanups. These cleanups are potentially unsafe and may
signals. */); lead to deadlocks or data corruption, but it usually works and may
preserve data in modified buffers that would otherwise be lost.
If nil, Emacs crashes immediately in response to fatal signals. */);
attempt_orderly_shutdown_on_fatal_signal = true; attempt_orderly_shutdown_on_fatal_signal = true;
/* Create the initial keyboard. Qt means 'unset'. */ /* Create the initial keyboard. Qt means 'unset'. */