branch: externals/counsel
commit 929da00d65caaf3901676b889910c8fc43121bbe
Author: Basil L. Contovounesios <conto...@tcd.ie>
Commit: Basil L. Contovounesios <conto...@tcd.ie>
Document use of locate-command
* counsel.el (counsel-locate-cmd-default)
(counsel-locate-cmd-noregex): Mention locate-command in
docstring (#2859).
---
counsel.el | 8 ++++++--
1 file changed, 6 insertions(+), 2 deletions(-)
diff --git a/counsel.el b/counsel.el
index 6655a6c..c176820 100644
--- a/counsel.el
+++ b/counsel.el
@@ -2620,7 +2620,9 @@ string - the full shell command to run."
(defvar locate-command)
(defun counsel-locate-cmd-default (input)
- "Return a `locate' shell command based on regexp INPUT."
+ "Return a `locate' shell command based on regexp INPUT.
+This uses the user option `locate-command' from the `locate'
+library, which see."
(counsel-require-program locate-command)
(format "%s -i --regex %s"
locate-command
@@ -2629,7 +2631,9 @@ string - the full shell command to run."
(ivy--regex input)))))
(defun counsel-locate-cmd-noregex (input)
- "Return a `locate' shell command based on INPUT."
+ "Return a `locate' shell command based on INPUT.
+This uses the user option `locate-command' from the `locate'
+library, which see."
(counsel-require-program locate-command)
(format "%s -i %s"
locate-command
