summaryrefslogtreecommitdiff
path: root/doc/lispref/compile.texi
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2021-09-28 15:00:50 +0300
committerEli Zaretskii <eliz@gnu.org>2021-09-28 15:00:50 +0300
commit90655e4bc01ba8d00be3281d13cc771b53e75b43 (patch)
treed0f734ef8d6a148745faa261feeb519dc65bd1bd /doc/lispref/compile.texi
parentb02a7ad2631b6ac3a95e53cb26a0aa1b1ab7e98a (diff)
downloademacs-90655e4bc01ba8d00be3281d13cc771b53e75b43.tar.gz
Make the build of source tarball produce *.eln files
* lisp/emacs-lisp/comp.el (batch-native-compile): Accept an optional argument; if non-nil, place the .eln file as appropriate for building a source tarball. * doc/lispref/compile.texi (Native-Compilation Functions): Document the new optional argument of 'batch-native-compile'. * lisp/Makefile.in (.PHONY, $(THEFILE)n) [HAVE_NATIVE_COMP]: New targets. * src/Makefile.in (%.eln) [HAVE_NATIVE_COMP]: New recipe. (all) [HAVE_NATIVE_COMP]: Add ../native-lisp to prerequisites. (elnlisp) [HAVE_NATIVE_COMP]: New list of *.eln files. (../native-lisp) [HAVE_NATIVE_COMP]: New recipe. * src/verbose.mk.in (AM_V_ELN): New macro.
Diffstat (limited to 'doc/lispref/compile.texi')
-rw-r--r--doc/lispref/compile.texi11
1 files changed, 9 insertions, 2 deletions
diff --git a/doc/lispref/compile.texi b/doc/lispref/compile.texi
index f48f4f47e8b..15d1f4ce53a 100644
--- a/doc/lispref/compile.texi
+++ b/doc/lispref/compile.texi
@@ -904,13 +904,20 @@ invokes the same Emacs executable as the process that called this
function.
@end defun
-@defun batch-native-compile
+@defun batch-native-compile &optional for-tarball
This function runs native-compilation on files specified on the Emacs
command line in batch mode. It must be used only in a batch execution
of Emacs, as it kills Emacs upon completion of the compilation. If
one or more of the files fail to compile, the Emacs process will
attempt to compile all the other files, and will terminate with a
-non-zero status code.
+non-zero status code. The optional argument @var{for-tarball}, if
+non-@code{nil}, tells the function to place the resulting @file{.eln}
+files in the last directory mentioned in
+@code{native-comp-eln-load-path} (@pxref{Library Search}); this is
+meant to be used as part of building an Emacs source tarball for the
+first time, when the natively-compiled files, which are absent from
+the source tarball, should be generated in the build tree instead of
+the user's cache directory.
@end defun
Native compilation can be run entirely asynchronously, in a subprocess