From: Eli Zaretskii <eliz@gnu.org>
Date: Sat, 10 May 2025 19:23:27 +0000 (+0300)
Subject: ; * lisp/emacs-lisp/comp.el (native-compile-prune-cache): Doc fix.
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=eba942682e7705d348dc998566952882363e6f08;p=emacs.git

; * lisp/emacs-lisp/comp.el (native-compile-prune-cache): Doc fix.

(cherry picked from commit 2d5f2434706a17055325432d6eb2b711ac785220)
---

diff --git a/lisp/emacs-lisp/comp.el b/lisp/emacs-lisp/comp.el
index 2cd3d2d03b9..a5a11c271c1 100644
--- a/lisp/emacs-lisp/comp.el
+++ b/lisp/emacs-lisp/comp.el
@@ -3724,12 +3724,22 @@ variable \"NATIVE_DISABLED\" is set, only byte compile."
 
 ;;;###autoload
 (defun native-compile-prune-cache ()
-  "Remove .eln files that aren't applicable to the current Emacs invocation."
+  "Remove *.eln files that aren't usable by the current Emacs build.
+
+This command removes all the *.eln files in `native-comp-eln-load-path'
+which are incompatible with the Emacs session in which you invoke this
+command.  This includes the *.eln files compiled by all the Emacs
+sessions where `comp-native-version-dir' had a value different from the
+current session.
+
+Note that this command does not prune the *.eln files in the last
+directory in `native-comp-eln-load-path', which holds *.eln files
+compiled during the Emacs build process."
   (interactive)
   (unless (featurep 'native-compile)
     (user-error "This Emacs isn't built with native-compile support"))
-  ;; The last item in native-comp-eln-load-path is assumed to be a system
-  ;; directory, so don't try to delete anything there (bug#59658).
+  ;; The last directory in 'native-comp-eln-load-path' is assumed to be a
+  ;; system directory, so don't try to delete anything there (bug#59658).
   (dolist (dir (butlast native-comp-eln-load-path))
     ;; If a directory is non absolute it is assumed to be relative to
     ;; `invocation-directory'.