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.
This commit is contained in:
Eli Zaretskii 2024-02-29 15:37:19 +02:00
parent 62bdd307a7
commit 3923998240
2 changed files with 14 additions and 9 deletions

View file

@ -1960,6 +1960,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

View file

@ -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)