]> git.eshelyaron.com Git - emacs.git/commitdiff
* lisp/emacs-lisp/comp.el (native-compile-async): Doc fix.
authorStefan Kangas <stefan@marxist.se>
Thu, 19 Nov 2020 21:11:17 +0000 (22:11 +0100)
committerStefan Kangas <stefan@marxist.se>
Fri, 20 Nov 2020 20:06:09 +0000 (21:06 +0100)
lisp/emacs-lisp/comp.el

index 095bd63a10f8e8ac8dfeaa7c00a156e366db47a4..2f1e8965c1b2013e4f983f3227b8ca706f1258d7 100644 (file)
@@ -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)