From: Stefan Kangas <stefan@marxist.se>
Date: Thu, 19 Nov 2020 21:11:17 +0000 (+0100)
Subject: * lisp/emacs-lisp/comp.el (native-compile-async): Doc fix.
X-Git-Tag: emacs-28.0.90~2727^2~304
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=c60355582a3ed19b4cc7e04b3b2031e461ccf7f1;p=emacs.git

* lisp/emacs-lisp/comp.el (native-compile-async): Doc fix.
---

diff --git a/lisp/emacs-lisp/comp.el b/lisp/emacs-lisp/comp.el
index 095bd63a10f..2f1e8965c1b 100644
--- a/lisp/emacs-lisp/comp.el
+++ b/lisp/emacs-lisp/comp.el
@@ -3489,13 +3489,28 @@ environment variable 'NATIVE_DISABLED' is set byte compile only."
 (defun native-compile-async (paths &optional recursively load)
   "Compile PATHS asynchronously.
 PATHS is one path or a list of paths to files or directories.
-`comp-async-jobs-number' specifies the number of (commands) to
-run simultaneously.  If RECURSIVELY, recurse into subdirectories
-of given directories.
-LOAD can be nil t or 'late."
+
+If optional argument RECURSIVELY is non-nil, recurse into
+subdirectories of given directories.
+
+If optional argument LOAD is non-nil, request to load the file
+after compiling.
+
+The variable `comp-async-jobs-number' specifies the number
+of (commands) to run simultaneously.
+
+LOAD can also be the symbol `late'.  This is used internally if
+the byte code has already been loaded when this function is
+called.  It means that we requests the special kind of load,
+necessary in that situation, called \"late\" loading.
+
+During a \"late\" load instead of executing all top level forms
+of the original files, only function definitions are
+loaded (paying attention to have these effective only if the
+bytecode definition was not changed in the meanwhile)."
   (comp-ensure-native-compiler)
   (unless (member load '(nil t late))
-    (error "LOAD must be nil t or 'late"))
+    (error "LOAD must be nil, t or 'late"))
   (unless (listp paths)
     (setf paths (list paths)))
   (let (files)