From: Stefan Kangas <stefan@marxist.se>
Date: Sun, 9 Jan 2022 02:15:34 +0000 (+0100)
Subject: Clarify docstring of package-native-compile
X-Git-Tag: emacs-28.0.92~122
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=30f1bdb41f;p=emacs.git

Clarify docstring of package-native-compile

* lisp/emacs-lisp/package.el (package-native-compile): Clarify
docstring.
---

diff --git a/lisp/emacs-lisp/package.el b/lisp/emacs-lisp/package.el
index 8fc54945d61..1387439f0ab 100644
--- a/lisp/emacs-lisp/package.el
+++ b/lisp/emacs-lisp/package.el
@@ -397,7 +397,13 @@ a sane initial value."
   :type '(repeat symbol))
 
 (defcustom package-native-compile nil
-  "Non-nil means to native compile packages on installation."
+  "Non-nil means to native compile packages after installing them.
+This controls ahead-of-time compilation.  If this option is nil,
+packages are normally compiled after they have been loaded for
+the first time.
+
+This option does not have any effect if Emacs was not built with
+native compilation support."
   :type '(boolean)
   :risky t
   :version "28.1")