summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPhilipp Stephani <phst@google.com>2017-01-31 21:10:03 +0100
committerPhilipp Stephani <phst@google.com>2017-01-31 21:10:03 +0100
commit7c1e598a0559db79a5166e34514413e3f524eeff (patch)
tree0ddfcc4a1735ed3533da0cd41809feee11549d16
parent4d81eb450ef5219b551e01e7df7f08784fdc3231 (diff)
downloademacs-7c1e598a0559db79a5166e34514413e3f524eeff.tar.gz
Document `byte-compile-debug' in the ELisp manual
* doc/lispref/compile.texi: Document variable `byte-compile-debug'.
-rw-r--r--doc/lispref/compile.texi9
1 files changed, 6 insertions, 3 deletions
diff --git a/doc/lispref/compile.texi b/doc/lispref/compile.texi
index b1cc04be09d..441ee9afb26 100644
--- a/doc/lispref/compile.texi
+++ b/doc/lispref/compile.texi
@@ -89,9 +89,12 @@ the @code{byte-compile} function. You can compile a whole file with
@code{byte-recompile-directory} or @code{batch-byte-compile}.
Sometimes, the byte compiler produces warning and/or error messages
-(@pxref{Compiler Errors}, for details). These messages are recorded
-in a buffer called @file{*Compile-Log*}, which uses Compilation mode.
-@xref{Compilation Mode,,,emacs, The GNU Emacs Manual}.
+(@pxref{Compiler Errors}, for details). These messages are normally
+recorded in a buffer called @file{*Compile-Log*}, which uses
+Compilation mode. @xref{Compilation Mode,,,emacs, The GNU Emacs
+Manual}. However, if the variable @code{byte-compile-debug} is
+non-nil, error message will be signaled as Lisp errors instead
+(@pxref{Errors}).
@cindex macro compilation
Be careful when writing macro calls in files that you intend to