From b2bf2a254fba3ec86fb763a95289f51251428ac4 Mon Sep 17 00:00:00 2001
From: Glenn Morris <rgm@gnu.org>
Date: Thu, 13 Feb 2014 22:59:24 -0800
Subject: [PATCH] Mention read-regexp in doc of functions that use it

* lisp/dired.el (dired-read-regexp):
* lisp/faces.el (list-faces-display):
* lisp/misearch.el (multi-isearch-read-matching-buffers)
(multi-isearch-read-matching-files):
* lisp/play/cookie1.el (cookie-apropos):
* lisp/progmodes/grep.el (grep-read-regexp): Doc fixes.
---
 lisp/ChangeLog         | 7 +++++++
 lisp/dired.el          | 1 +
 lisp/faces.el          | 2 +-
 lisp/misearch.el       | 7 +++++--
 lisp/play/cookie1.el   | 1 +
 lisp/progmodes/grep.el | 2 +-
 6 files changed, 16 insertions(+), 4 deletions(-)

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index c6498210524..21eeff7bffe 100644
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,5 +1,12 @@
 2014-02-14  Glenn Morris  <rgm@gnu.org>
 
+	* dired.el (dired-read-regexp):
+	* faces.el (list-faces-display):
+	* misearch.el (multi-isearch-read-matching-buffers)
+	(multi-isearch-read-matching-files):
+	* play/cookie1.el (cookie-apropos):
+	* progmodes/grep.el (grep-read-regexp): Doc fixes.
+
 	* textmodes/remember.el (remember): Use frameset-to-register
 	rather than frame-configuration-to-register.
 
diff --git a/lisp/dired.el b/lisp/dired.el
index faa39ab5d6c..b1b22a6a99a 100644
--- a/lisp/dired.el
+++ b/lisp/dired.el
@@ -3284,6 +3284,7 @@ As always, hidden subdirs are not affected."
   "History list of regular expressions used in Dired commands.")
 
 (defun dired-read-regexp (prompt &optional default history)
+  "Read a regexp using `read-regexp'."
   (read-regexp prompt default (or history 'dired-regexp-history)))
 
 (defun dired-mark-files-regexp (regexp &optional marker-char)
diff --git a/lisp/faces.el b/lisp/faces.el
index ed36522afb1..3394c721f04 100644
--- a/lisp/faces.el
+++ b/lisp/faces.el
@@ -1260,7 +1260,7 @@ The sample text is a string that comes from the variable
 
 If REGEXP is non-nil, list only those faces with names matching
 this regular expression.  When called interactively with a prefix
-arg, prompt for a regular expression."
+argument, prompt for a regular expression using `read-regexp'."
   (interactive (list (and current-prefix-arg
                           (read-regexp "List faces matching regexp"))))
   (let ((all-faces (zerop (length regexp)))
diff --git a/lisp/misearch.el b/lisp/misearch.el
index af3b1b45b2b..64ea40b7a1d 100644
--- a/lisp/misearch.el
+++ b/lisp/misearch.el
@@ -239,7 +239,8 @@ set in `multi-isearch-buffers' or `multi-isearch-buffers-regexp'."
     (nreverse bufs)))
 
 (defun multi-isearch-read-matching-buffers ()
-  "Return a list of buffers whose names match specified regexp."
+  "Return a list of buffers whose names match specified regexp.
+Uses `read-regexp' to read the regexp."
   ;; Most code from `multi-occur-in-matching-buffers'
   ;; and `kill-matching-buffers'.
   (let ((bufregexp
@@ -322,8 +323,10 @@ Every next/previous file in the defined sequence is visited by
       (add-to-list 'files file))
     (nreverse files)))
 
+;; A regexp is not the same thing as a file glob - does this matter?
 (defun multi-isearch-read-matching-files ()
-  "Return a list of files whose names match specified wildcard."
+  "Return a list of files whose names match specified wildcard.
+Uses `read-regexp' to read the wildcard."
   ;; Most wildcard code from `find-file-noselect'.
   (let ((filename (read-regexp "Search in files whose names match wildcard")))
     (when (and filename
diff --git a/lisp/play/cookie1.el b/lisp/play/cookie1.el
index 38619b1d26a..4d49fca7568 100644
--- a/lisp/play/cookie1.el
+++ b/lisp/play/cookie1.el
@@ -187,6 +187,7 @@ Argument REQUIRE-MATCH non-nil forces a matching cookie."
 
 (defun cookie-apropos (regexp phrase-file &optional display)
   "Return a list of all entries matching REGEXP from PHRASE-FILE.
+Interactively, uses `read-regexp' to read REGEXP.
 Interactively, PHRASE-FILE defaults to `cookie-file', unless that
 is nil or a prefix argument is used.
 If called interactively, or if DISPLAY is non-nil, display a list of matches."
diff --git a/lisp/progmodes/grep.el b/lisp/progmodes/grep.el
index 3c7f936446f..99629450c1b 100644
--- a/lisp/progmodes/grep.el
+++ b/lisp/progmodes/grep.el
@@ -819,7 +819,7 @@ substitution string.  Note dynamic scoping of variables.")
 		 t t command))))))
 
 (defun grep-read-regexp ()
-  "Read regexp arg for interactive grep."
+  "Read regexp arg for interactive grep using `read-regexp'."
   (read-regexp "Search for" 'grep-tag-default 'grep-regexp-history))
 
 (defun grep-read-files (regexp)
-- 
2.11.4.GIT