diff options
| author | Eli Zaretskii | 2020-07-17 17:54:00 +0300 |
|---|---|---|
| committer | Eli Zaretskii | 2020-07-17 17:54:00 +0300 |
| commit | 0d4ba1c2b27cb36423400e697a19d7cf80352a54 (patch) | |
| tree | 454c97c276d8603c853c80015c86053760b8e801 | |
| parent | b3bbd4fd00562578e840fbdaec5ed2000392d9e3 (diff) | |
| download | emacs-0d4ba1c2b27cb36423400e697a19d7cf80352a54.tar.gz emacs-0d4ba1c2b27cb36423400e697a19d7cf80352a54.zip | |
Improve documentation of 'kill-emacs'
* doc/lispref/os.texi (Killing Emacs):
* src/emacs.c (Fkill_emacs): Document what non-integer, non-string
argument to 'kill-emacs' means. (Bug#42400)
| -rw-r--r-- | doc/lispref/os.texi | 4 | ||||
| -rw-r--r-- | src/emacs.c | 2 |
2 files changed, 6 insertions, 0 deletions
diff --git a/doc/lispref/os.texi b/doc/lispref/os.texi index 1c3be1c7ef6..b31ab87ff17 100644 --- a/doc/lispref/os.texi +++ b/doc/lispref/os.texi | |||
| @@ -707,6 +707,10 @@ the Emacs process. (This is useful primarily in batch operation; see | |||
| 707 | If @var{exit-data} is a string, its contents are stuffed into the | 707 | If @var{exit-data} is a string, its contents are stuffed into the |
| 708 | terminal input buffer so that the shell (or whatever program next reads | 708 | terminal input buffer so that the shell (or whatever program next reads |
| 709 | input) can read them. | 709 | input) can read them. |
| 710 | |||
| 711 | If @var{exit-data} is neither an integer nor a string, or is omitted, | ||
| 712 | that means to use the (system-specific) exit status which indicates | ||
| 713 | successful program termination. | ||
| 710 | @end deffn | 714 | @end deffn |
| 711 | 715 | ||
| 712 | @cindex SIGTERM | 716 | @cindex SIGTERM |
diff --git a/src/emacs.c b/src/emacs.c index 6118ad34454..1dcf1958912 100644 --- a/src/emacs.c +++ b/src/emacs.c | |||
| @@ -2352,6 +2352,8 @@ DEFUN ("kill-emacs", Fkill_emacs, Skill_emacs, 0, 1, "P", | |||
| 2352 | doc: /* Exit the Emacs job and kill it. | 2352 | doc: /* Exit the Emacs job and kill it. |
| 2353 | If ARG is an integer, return ARG as the exit program code. | 2353 | If ARG is an integer, return ARG as the exit program code. |
| 2354 | If ARG is a string, stuff it as keyboard input. | 2354 | If ARG is a string, stuff it as keyboard input. |
| 2355 | Any other value of ARG, or ARG omitted, means return an | ||
| 2356 | exit code that indicates successful program termination. | ||
| 2355 | 2357 | ||
| 2356 | This function is called upon receipt of the signals SIGTERM | 2358 | This function is called upon receipt of the signals SIGTERM |
| 2357 | or SIGHUP, and upon SIGINT in batch mode. | 2359 | or SIGHUP, and upon SIGINT in batch mode. |