'xref-search-program'-related doc string fixes

* lisp/progmodes/xref.el (xref-search-program): Mention what this
variable controls.
(xref-matches-in-files): Mention the variables that controls it.
This commit is contained in:
Lars Ingebrigtsen 2021-09-25 11:54:13 +02:00
parent f90b026978
commit bcbae720d5
2 changed files with 10 additions and 2 deletions

View file

@ -2474,6 +2474,7 @@ visit. 'xref-auto-jump-to-first-xref' changes their behavior much in
the same way as 'xref-auto-jump-to-first-definition' affects the
"find-definitions" commands.
---
*** New user options 'xref-search-program' and 'xref-search-program-alist'.
So far 'grep' and 'ripgrep' are supported. 'ripgrep' seems to offer better
performance in certain cases, in particular for case-insensitive

View file

@ -1648,7 +1648,11 @@ The template should have the following fields:
(defcustom xref-search-program 'grep
"The program to use for regexp search inside files.
This must reference a corresponding entry in `xref-search-program-alist'."
This must reference a corresponding entry in `xref-search-program-alist'.
This variable is used in `xref-matches-in-files', which is the
utility function used by commands like `dired-do-find-regexp' and
`project-find-regexp'."
:type '(choice
(const :tag "Use Grep" grep)
(const :tag "Use ripgrep" ripgrep)
@ -1660,7 +1664,10 @@ This must reference a corresponding entry in `xref-search-program-alist'."
(defun xref-matches-in-files (regexp files)
"Find all matches for REGEXP in FILES.
Return a list of xref values.
FILES must be a list of absolute file names."
FILES must be a list of absolute file names.
See `xref-search-program' and `xref-search-program-alist' for how
to control which program to use when looking for matches."
(cl-assert (consp files))
(require 'grep)
(defvar grep-highlight-matches)