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

Improve documentation of 'kill-emacs'

Browse source 
* doc/lispref/os.texi (Killing Emacs):
* src/emacs.c (Fkill_emacs): Document what non-integer, non-string
argument to 'kill-emacs' means.  (Bug#42400)
This commit is contained in:
Eli Zaretskii 2020-07-17 17:54:00 +03:00
parent b3bbd4fd00
commit 0d4ba1c2b2
2 changed files with 6 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
doc/lispref/os.texi
View file

@ -707,6 +707,10 @@ the Emacs process. (This is useful primarily in batch operation; see
If @var{exit-data} is a string, its contents are stuffed into the
terminal input buffer so that the shell (or whatever program next reads
input) can read them.
If @var{exit-data} is neither an integer nor a string, or is omitted,
that means to use the (system-specific) exit status which indicates
successful program termination.
@end deffn
@cindex SIGTERM

2
src/emacs.c
View file

@ -2352,6 +2352,8 @@ DEFUN ("kill-emacs", Fkill_emacs, Skill_emacs, 0, 1, "P",
doc: /* Exit the Emacs job and kill it.
If ARG is an integer, return ARG as the exit program code.
If ARG is a string, stuff it as keyboard input.
Any other value of ARG, or ARG omitted, means return an
exit code that indicates successful program termination.
This function is called upon receipt of the signals SIGTERM
or SIGHUP, and upon SIGINT in batch mode.