aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorStephen Leake2019-07-30 11:02:03 -0700
committerStephen Leake2019-07-30 11:02:03 -0700
commit056cbcb7a959463290bc91c19b909cbf3eb47d0a (patch)
tree291f4e05718203b70223da435e492d4d1f887dd3
parentd0eeb62c43cc3041b322249b488ad157c506abaa (diff)
downloademacs-056cbcb7a959463290bc91c19b909cbf3eb47d0a.tar.gz
emacs-056cbcb7a959463290bc91c19b909cbf3eb47d0a.zip
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.
-rw-r--r--lisp/emacs-lisp/bytecomp.el7
-rw-r--r--lisp/progmodes/compile.el5
-rw-r--r--lisp/progmodes/grep.el7
3 files changed, 11 insertions, 8 deletions
diff --git a/lisp/emacs-lisp/bytecomp.el b/lisp/emacs-lisp/bytecomp.el
index 431525431a4..125344b779b 100644
--- a/lisp/emacs-lisp/bytecomp.el
+++ b/lisp/emacs-lisp/bytecomp.el
@@ -1037,9 +1037,10 @@ If STR is something like \"Buffer foo.el\", return #<buffer foo.el>
1037we go into emacs-lisp-compilation-mode.") 1037we go into emacs-lisp-compilation-mode.")
1038 1038
1039(defcustom emacs-lisp-compilation-search-path '(nil) 1039(defcustom emacs-lisp-compilation-search-path '(nil)
1040 "Search path for byte-compile error messages. 1040 "Directories to search for files named in byte-compile error messages.
1041Elements should be directory names, not file names of directories. 1041Value should be a list of directory names, not file names of
1042The value nil as an element means to try the default directory." 1042directories. The value nil as an element means the byte-compile
1043message buffer `default-directory'."
1043 :version "27.1" 1044 :version "27.1"
1044 :type '(repeat (choice (const :tag "Default" nil) 1045 :type '(repeat (choice (const :tag "Default" nil)
1045 (string :tag "Directory")))) 1046 (string :tag "Directory"))))
diff --git a/lisp/progmodes/compile.el b/lisp/progmodes/compile.el
index 4b2fc516c3d..7537525a063 100644
--- a/lisp/progmodes/compile.el
+++ b/lisp/progmodes/compile.el
@@ -677,8 +677,9 @@ of `my-compilation-root' here."
677;;;###autoload 677;;;###autoload
678(defcustom compilation-search-path '(nil) 678(defcustom compilation-search-path '(nil)
679 "List of directories to search for source files named in error messages. 679 "List of directories to search for source files named in error messages.
680Elements should be directory names, not file names of directories. 680Elements should be directory names, not file names of
681The value nil as an element means to try the default directory." 681directories. The value nil as an element means the error
682message buffer `default-directory'."
682 :type '(repeat (choice (const :tag "Default" nil) 683 :type '(repeat (choice (const :tag "Default" nil)
683 (string :tag "Directory")))) 684 (string :tag "Directory"))))
684 685
diff --git a/lisp/progmodes/grep.el b/lisp/progmodes/grep.el
index 67222f78627..306ae8fd50f 100644
--- a/lisp/progmodes/grep.el
+++ b/lisp/progmodes/grep.el
@@ -442,9 +442,10 @@ abbreviated part can also be toggled with
442 :group 'grep) 442 :group 'grep)
443 443
444(defcustom grep-search-path '(nil) 444(defcustom grep-search-path '(nil)
445 "Search path for grep results. 445 "List of directories to search for files named in grep messages.
446Elements should be directory names, not file names of directories. 446Elements should be directory names, not file names of
447The value nil as an element means to try the default directory." 447directories. The value nil as an element means the grep messages
448buffer `default-directory'."
448 :group 'grep 449 :group 'grep
449 :version "27.1" 450 :version "27.1"
450 :type '(repeat (choice (const :tag "Default" nil) 451 :type '(repeat (choice (const :tag "Default" nil)