diff options
| author | Eli Zaretskii | 2018-07-21 12:28:11 +0300 |
|---|---|---|
| committer | Eli Zaretskii | 2018-07-21 12:28:11 +0300 |
| commit | 7308fa0e2b8d929a4e0f7f54ac46228f93674672 (patch) | |
| tree | c71a223dda28f18e82ec8c1f161e8f177dea669b /src | |
| parent | 61de292c72382403633f753c3d632a560ccfee98 (diff) | |
| download | emacs-7308fa0e2b8d929a4e0f7f54ac46228f93674672.tar.gz emacs-7308fa0e2b8d929a4e0f7f54ac46228f93674672.zip | |
Improve doc strings of several variables in keyboard.c
* 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.
Diffstat (limited to 'src')
| -rw-r--r-- | src/keyboard.c | 28 |
1 files changed, 15 insertions, 13 deletions
diff --git a/src/keyboard.c b/src/keyboard.c index e62dd0ec489..1da5ac088d3 100644 --- a/src/keyboard.c +++ b/src/keyboard.c | |||
| @@ -11854,10 +11854,10 @@ if the command is in this list, the selection is not updated. */); | |||
| 11854 | 11854 | ||
| 11855 | DEFVAR_LISP ("debug-on-event", | 11855 | DEFVAR_LISP ("debug-on-event", |
| 11856 | Vdebug_on_event, | 11856 | Vdebug_on_event, |
| 11857 | doc: /* Enter debugger on this event. When Emacs | 11857 | doc: /* Enter debugger on this event. |
| 11858 | receives the special event specified by this variable, it will try to | 11858 | When Emacs receives the special event specified by this variable, |
| 11859 | break into the debugger as soon as possible instead of processing the | 11859 | it will try to break into the debugger as soon as possible instead |
| 11860 | event normally through `special-event-map'. | 11860 | of processing the event normally through `special-event-map'. |
| 11861 | 11861 | ||
| 11862 | Currently, the only supported values for this | 11862 | Currently, the only supported values for this |
| 11863 | variable are `sigusr1' and `sigusr2'. */); | 11863 | variable are `sigusr1' and `sigusr2'. */); |
| @@ -11865,21 +11865,23 @@ variable are `sigusr1' and `sigusr2'. */); | |||
| 11865 | 11865 | ||
| 11866 | DEFVAR_BOOL ("attempt-stack-overflow-recovery", | 11866 | DEFVAR_BOOL ("attempt-stack-overflow-recovery", |
| 11867 | attempt_stack_overflow_recovery, | 11867 | attempt_stack_overflow_recovery, |
| 11868 | doc: /* If non-nil, attempt to recover from C stack | 11868 | doc: /* If non-nil, attempt to recover from C stack overflows. |
| 11869 | overflow. This recovery is unsafe and may lead to deadlocks or data | 11869 | This recovery is potentially unsafe and may lead to deadlocks or data |
| 11870 | corruption, but it usually works and may preserve modified buffers | 11870 | corruption, but it usually works and may preserve modified buffers |
| 11871 | that would otherwise be lost. If nil, treat stack overflow like any | 11871 | that would otherwise be lost. If nil, treat stack overflow like any |
| 11872 | other kind of crash. */); | 11872 | other kind of crash or fatal error. */); |
| 11873 | attempt_stack_overflow_recovery = true; | 11873 | attempt_stack_overflow_recovery = true; |
| 11874 | 11874 | ||
| 11875 | DEFVAR_BOOL ("attempt-orderly-shutdown-on-fatal-signal", | 11875 | DEFVAR_BOOL ("attempt-orderly-shutdown-on-fatal-signal", |
| 11876 | attempt_orderly_shutdown_on_fatal_signal, | 11876 | attempt_orderly_shutdown_on_fatal_signal, |
| 11877 | doc: /* If non-nil, attempt to perform an orderly | 11877 | doc: /* If non-nil, attempt orderly shutdown on fatal signals. |
| 11878 | shutdown when Emacs receives a fatal signal (e.g., a crash). | 11878 | By default this variable is non-nil, and Emacs attempts to perform |
| 11879 | This cleanup is unsafe and may lead to deadlocks or data corruption, | 11879 | an orderly shutdown when it catches a fatal signal (e.g., a crash). |
| 11880 | but it usually works and may preserve modified buffers that would | 11880 | The orderly shutdown includes an attempt to auto-save your unsaved edits |
| 11881 | otherwise be lost. If nil, crash immediately in response to fatal | 11881 | and other useful cleanups. These cleanups are potentially unsafe and may |
| 11882 | signals. */); | 11882 | lead to deadlocks or data corruption, but it usually works and may |
| 11883 | preserve data in modified buffers that would otherwise be lost. | ||
| 11884 | If nil, Emacs crashes immediately in response to fatal signals. */); | ||
| 11883 | attempt_orderly_shutdown_on_fatal_signal = true; | 11885 | attempt_orderly_shutdown_on_fatal_signal = true; |
| 11884 | 11886 | ||
| 11885 | /* Create the initial keyboard. Qt means 'unset'. */ | 11887 | /* Create the initial keyboard. Qt means 'unset'. */ |