From: Dmitry Gutov <dgutov@yandex.ru>
Date: Fri, 4 Dec 2020 21:22:22 +0000 (+0200)
Subject: Improve docstrings
X-Git-Tag: emacs-28.0.90~4920
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=27af17b9ee61cf3b08be179055dabb8c684e4da2;p=emacs.git

Improve docstrings

* lisp/progmodes/xref.el (xref-search-program-alist)
(xref-search-program): Improve docstrings.
---

diff --git a/lisp/progmodes/xref.el b/lisp/progmodes/xref.el
index ccd5e1ae8b1..ca14f6ae6c6 100644
--- a/lisp/progmodes/xref.el
+++ b/lisp/progmodes/xref.el
@@ -1286,8 +1286,9 @@ IGNORES is a list of glob patterns for files to ignore."
 Program identifier should be a symbol, named after the search program.
 
 The command template must be a shell command (or usually a
-pipeline) that will search the list of files which will be piped
-from stdin.  The template should have following fields:
+pipeline) that will search the files based on the list of file
+names that is piped from stdin, separated by null characters.
+The template should have the following fields:
 
   <C> for extra arguments such as -i and --color
   <R> for the regexp itself (in Extended format)"
@@ -1296,7 +1297,7 @@ from stdin.  The template should have following fields:
                 (string :tag "Command template"))))
 
 (defcustom xref-search-program 'grep
-  "The program to use to search inside files.
+  "The program to use for regexp search inside files.
 
 This must reference a corresponding entry in `xref-search-program-alist'."
   :type `(choice