From: Eli Zaretskii <eliz@gnu.org>
Date: Sun, 8 Dec 2024 05:47:07 +0000 (+0200)
Subject: ; Improve doc strings in compile.el
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=becca9fb4277473bf4ec44fac2f9ea3ed1e09b82;p=emacs.git

; Improve doc strings in compile.el

* lisp/progmodes/compile.el (compilation-transform-file-match-alist)
(compilation-error-regexp-alist): Doc fixes.

(cherry picked from commit 59fa0b1dd6eba2d3fcc2568d79b3586638dbed04)
---

diff --git a/lisp/progmodes/compile.el b/lisp/progmodes/compile.el
index 0b7cb7561a0..9c50efb8b95 100644
--- a/lisp/progmodes/compile.el
+++ b/lisp/progmodes/compile.el
@@ -61,16 +61,18 @@ If nil, use Emacs default."
 
 (defcustom compilation-transform-file-match-alist
   '(("/bin/[a-z]*sh\\'" nil))
-  "Alist of regexp/replacements to alter file names in compilation errors.
-If the replacement is nil, the file will not be considered an error
-after all.  If not nil, it should be a regexp replacement string.
+  "Alist of regexp/replacements to alter file names in compiler messages.
+If the replacement is nil, the matching message will not be considered
+an error or warning.  If not nil, it should be a replacement string
+for the matched regexp.
 
-When a replacement regexp is specified, the value of the file name used
-to locate the error is changed, but the compilation buffer still
-displays the original value.
+If a non-nil replacement is specified, the value of the matched file name
+used to locate the warning or error is modified using the replacement, but
+the compilation buffer still displays the original value.
 
-For example, to prepend a subdirectory \"bar/\" to all file names, add
-an entry matching \"\\\\=`\" and a replacement regexp of \"bar/\", i.e.:
+For example, to prepend a subdirectory \"bar/\" to all file names in
+compiler messages, add an entry matching \"\\\\=`\" and a replacement
+string of \"bar/\", i.e.:
 
     (\"\\\\=`\" \"bar/\")
 
@@ -826,10 +828,10 @@ Alternatively, FACE can evaluate to a property list of the
 form (face FACE PROP1 VAL1 PROP2 VAL2 ...), in which case all the
 listed text properties PROP# are given values VAL# as well.
 
-After identifying errors and warnings determined by this
+After identifying compilation errors and warnings determined by this
 variable, the `compilation-transform-file-match-alist' variable
 is then consulted.  It allows further transformations of the
-matched file names, and weeding out false positives."
+matched file names, and ignoring false positives."
   :type '(repeat (choice (symbol :tag "Predefined symbol")
 			 (sexp :tag "Error specification")))
   :link `(file-link :tag "example file"