summaryrefslogtreecommitdiff
path: root/src/eval.c
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2023-11-09 10:33:28 +0200
committerEli Zaretskii <eliz@gnu.org>2023-11-09 10:33:28 +0200
commitfe000236cf278a469adbf27e2184f823f7e12587 (patch)
treedf9a5ee657aeedd185224af56a7d8b42416aa14f /src/eval.c
parent103ca678ac1a043c9afbb7a419adb7ddf7a624ef (diff)
downloademacs-fe000236cf278a469adbf27e2184f823f7e12587.tar.gz
emacs-fe000236cf278a469adbf27e2184f823f7e12587.tar.bz2
emacs-fe000236cf278a469adbf27e2184f823f7e12587.zip
Improve documentation of signaling errors in batch mode
* doc/lispref/control.texi (Signaling Errors) (Processing of Errors): * doc/lispref/os.texi (Batch Mode): * doc/lispref/debugging.texi (Invoking the Debugger): * lisp/emacs-lisp/debug.el (debug): * src/eval.c (Fsignal): * lisp/subr.el (error): Document more prominently that signaling an unhandled error in batch mode kills Emacs. Better documentation of backtrace in batch mode.
Diffstat (limited to 'src/eval.c')
-rw-r--r--src/eval.c4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/eval.c b/src/eval.c
index 2dd0c356e88..3a01617f702 100644
--- a/src/eval.c
+++ b/src/eval.c
@@ -1666,6 +1666,10 @@ DEFUN ("signal", Fsignal, Ssignal, 2, 2, 0,
doc: /* Signal an error. Args are ERROR-SYMBOL and associated DATA.
This function does not return.
+When `noninteractive' is non-nil (in particular, in batch mode), an
+unhandled error calls `kill-emacs', which terminates the Emacs
+session with a non-zero exit code.
+
An error symbol is a symbol with an `error-conditions' property
that is a list of condition names. The symbol should be non-nil.
A handler for any of those names will get to handle this signal.