1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2026-01-30 12:21:25 -08:00

Improve doc strings for some -search-path variables

* lisp/emacs-lisp/bytecomp.el (emacs-lisp-compilation-search-path):
Improve doc string.

* lisp/progmodes/compile.el (compilation-search-path): Improve doc
string.

* lisp/progmodes/grep.el (grep-search-path): Improve doc string.
This commit is contained in:
Stephen Leake 2019-07-30 11:02:03 -07:00
parent d0eeb62c43
commit 056cbcb7a9
3 changed files with 11 additions and 8 deletions

View file

@ -1037,9 +1037,10 @@ If STR is something like \"Buffer foo.el\", return #<buffer foo.el>
we go into emacs-lisp-compilation-mode.")
(defcustom emacs-lisp-compilation-search-path '(nil)
"Search path for byte-compile error messages.
Elements should be directory names, not file names of directories.
The value nil as an element means to try the default directory."
"Directories to search for files named in byte-compile error messages.
Value should be a list of directory names, not file names of
directories. The value nil as an element means the byte-compile
message buffer `default-directory'."
:version "27.1"
:type '(repeat (choice (const :tag "Default" nil)
(string :tag "Directory"))))

View file

@ -677,8 +677,9 @@ of `my-compilation-root' here."
;;;###autoload
(defcustom compilation-search-path '(nil)
"List of directories to search for source files named in error messages.
Elements should be directory names, not file names of directories.
The value nil as an element means to try the default directory."
Elements should be directory names, not file names of
directories. The value nil as an element means the error
message buffer `default-directory'."
:type '(repeat (choice (const :tag "Default" nil)
(string :tag "Directory"))))

View file

@ -442,9 +442,10 @@ abbreviated part can also be toggled with
:group 'grep)
(defcustom grep-search-path '(nil)
"Search path for grep results.
Elements should be directory names, not file names of directories.
The value nil as an element means to try the default directory."
"List of directories to search for files named in grep messages.
Elements should be directory names, not file names of
directories. The value nil as an element means the grep messages
buffer `default-directory'."
:group 'grep
:version "27.1"
:type '(repeat (choice (const :tag "Default" nil)