Improve documentation of recent changes in comp-run.el

* lisp/emacs-lisp/comp-run.el
(native-comp-async-warnings-errors-kind): Rename from
'native-comp-async-report-warnings-errors-kind', and rename
'importants' to 'important'; all users changed.  Doc fix.

* etc/NEWS: Announce the new option.

(cherry picked from commit 39239982403f01a37d42d1cd8db0b2ed0b48b50c)

diff --git a/etc/NEWS b/etc/NEWS
index e2cde2df4af79467daabe18794b64e11428a4aff..fce41e2a468dc42e3aed2654387d87a0db4966b1 100644 (file)
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -2109,6 +2109,12 @@ The warning name is 'docstrings-control-chars'.
 *** The warning about wide docstrings can now be disabled separately.
 Its warning name is 'docstrings-wide'.
 
+---
+** New user option 'native-comp-async-warnings-errors-kind'.
+It allows control of what kinds of warnings and errors from asynchronous
+native compilation are reported to the parent Emacs process.  The
+default is to report all errors and only important warnings.
+
 +++
 ** New function declaration and property 'important-return-value'.
 The declaration '(important-return-value t)' sets the

diff --git a/lisp/emacs-lisp/comp-run.el b/lisp/emacs-lisp/comp-run.el
index eec50c39c6848ab1bb13130f3a5f6bfc656ab67c..057760322ab3966647362bfc52eac735c9c1dab7 100644 (file)
--- a/lisp/emacs-lisp/comp-run.el
+++ b/lisp/emacs-lisp/comp-run.el
@@ -77,17 +77,16 @@ buffer."
           (const :tag "Report but do not display warnings/errors" silent))
   :version "28.1")
 
-(defcustom native-comp-async-report-warnings-errors-kind 'importants
-  "Select which kind of warnings and errors to report.
+(defcustom native-comp-async-warnings-errors-kind 'important
+  "Which kind of warnings and errors to report from async native compilation.
 
-Set this variable to `importants' to have only important warnings and
-all errors to be reported.
-
-Set this variable to `all' to have all warnings and errors to be
-reported."
+Setting this variable to `important' (the default) will report
+only important warnings and all errors.
+Setting this variable to `all' will report all warnings and
+errors."
   :type '(choice
           (const :tag "Report all warnings/errors" all)
-          (const :tag "Report only important warnings and errors" importants))
+          (const :tag "Report important warnings and all errors" important))
   :version "30.1")
 
 (defcustom native-comp-always-compile nil
@@ -198,7 +197,7 @@ processes from `comp-async-compilations'"
              (if (eq native-comp-async-report-warnings-errors 'silent)
                  (cons '(comp) warning-suppress-types)
                warning-suppress-types))
-            (regexp (if (eq native-comp-async-report-warnings-errors-kind 'all)
+            (regexp (if (eq native-comp-async-warnings-errors-kind 'all)
                         "^.*?\\(?:Error\\|Warning\\): .*$"
                       (rx bol
                           (*? nonl)