]> git.eshelyaron.com Git - emacs.git/commitdiff
Improve doc strings for some -search-path variables
authorStephen Leake <stephen_leake@stephe-leake.org>
Tue, 30 Jul 2019 18:02:03 +0000 (11:02 -0700)
committerStephen Leake <stephen_leake@stephe-leake.org>
Tue, 30 Jul 2019 18:02:03 +0000 (11:02 -0700)
* 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.

lisp/emacs-lisp/bytecomp.el
lisp/progmodes/compile.el
lisp/progmodes/grep.el

index 431525431a407a08a8ca26d0cda6c646f3ccbf73..125344b779b975318fc05ced657fa03ae98a4ea4 100644 (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"))))
index 4b2fc516c3d1e6a2dc4304f90e97d5e547adbe3c..7537525a0631f350b96ab1cf0d1bf86730e15f89 100644 (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"))))
 
index 67222f78627117f5aa897dbb001216dbe965f505..306ae8fd50fd69988e03300406112d473d4da645 100644 (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)