summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2021-12-29 20:25:02 +0200
committerEli Zaretskii <eliz@gnu.org>2021-12-29 20:25:02 +0200
commit58d06af57d5942e87ca5c49ee941b426c76779e7 (patch)
tree7f16280b5778a52f9e8eb1038d9543b108e87037
parentf6e383c8bb2023793731fcebde88c15be721d8ee (diff)
downloademacs-58d06af57d5942e87ca5c49ee941b426c76779e7.tar.gz
emacs-58d06af57d5942e87ca5c49ee941b426c76779e7.tar.bz2
emacs-58d06af57d5942e87ca5c49ee941b426c76779e7.zip
; * lisp/replace.el (replace-regexp-function): Doc fix. (Bug#52558)
-rw-r--r--lisp/replace.el10
1 files changed, 7 insertions, 3 deletions
diff --git a/lisp/replace.el b/lisp/replace.el
index 2e877305c01..70d3ec73f88 100644
--- a/lisp/replace.el
+++ b/lisp/replace.el
@@ -2622,9 +2622,13 @@ It is called with three arguments, as if it were
`re-search-forward'.")
(defvar replace-regexp-function nil
- "Function to convert a search string to a regexp to replace.
-It's bound to `isearch-regexp-function' when searching
-for a string to replace.")
+ "Function to convert the FROM string of query-replace commands to a regexp.
+This is used by `query-replace', `query-replace-regexp', etc. as
+the value of `isearch-regexp-function' when they search for the
+occurences of the string/regexp to be replaced. This is intended
+to be used when the string to be replaced, as typed by the user,
+is not to be interpreted literally, but instead should be converted
+to a regexp that is actually used for the search.")
(defun replace-search (search-string limit regexp-flag delimited-flag
case-fold &optional backward)