From bcbae720d593e3b1e19315dbb7a5ba73174cbe40 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sat, 25 Sep 2021 11:54:13 +0200 Subject: [PATCH] '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. --- etc/NEWS | 1 + lisp/progmodes/xref.el | 11 +++++++++-- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/etc/NEWS b/etc/NEWS index 68853e423c0..33f6f5aacbc 100644 --- a/etc/NEWS +++ b/etc/NEWS @@ -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 diff --git a/lisp/progmodes/xref.el b/lisp/progmodes/xref.el index fb8090cfb72..af1413e0504 100644 --- a/lisp/progmodes/xref.el +++ b/lisp/progmodes/xref.el @@ -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) -- 2.39.2