all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
* Your commit re: Fix Bug#33618; define search path variables for grep, byte-compile
@ 2019-07-25 16:44 Eli Zaretskii
  0 siblings, 0 replies; only message in thread
From: Eli Zaretskii @ 2019-07-25 16:44 UTC (permalink / raw)
  To: Stephen Leake; +Cc: emacs-devel

Stephen,

The doc strings of the two new variables you added in that commit are
confusing.

  (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."

  (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."
    :version "27.1"
    :type '(repeat (choice (const :tag "Default" nil)
			   (string :tag "Directory"))))

What does it mean to "search directories for grep results" or for
"byte-compile error messages"?  Directories can only be searched for
files.  Only by reading the doc string of compilation-search-path did
I understand what you meant; please use that one as an example of how
these doc strings should be fixed.

Also, the "try the default directory" part is ambiguous (this part is
problematic also in compilation-search-path's doc string).  I'm
guessing you mean default-directory, in which case I'd suggest to say
"try the current buffer's `default-directory'" instead (if that is
accurate).

Please clarify these doc strings, as these are defcustoms, i.e. user
options.

TIA



^ permalink raw reply	[flat|nested] only message in thread

only message in thread, other threads:[~2019-07-25 16:44 UTC | newest]

Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2019-07-25 16:44 Your commit re: Fix Bug#33618; define search path variables for grep, byte-compile Eli Zaretskii

Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.