summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2026-05-22 14:46:13 +0300
committerEli Zaretskii <eliz@gnu.org>2026-05-22 14:46:13 +0300
commit7df8604ea635e7940af19e0fe06e5f644181f32e (patch)
treec4c0dc6d0b27d3b2240573c6f2570b0291d5e9e5 /doc
parent2936b36164ded60e0257f1ee872ff333bc4f4abd (diff)
; Improve documentation of lazy-highlight in search and replace commands
* lisp/isearch.el (lazy-highlight, lazy-highlight-initial-delay) (lazy-highlight-buffer, isearch-lazy-highlight, isearch-forward): * lisp/replace.el (query-replace, query-replace-lazy-highlight) (query-replace, query-replace-regexp): Doc fixes. * doc/emacs/search.texi (Search Customizations): Document 'lazy-highlight-buffer' and 'lazy-highlight-buffer-max-at-a-time'. Use @vtable to avoid the need of indexing each variable separately.
Diffstat (limited to 'doc')
-rw-r--r--doc/emacs/search.texi25
1 files changed, 16 insertions, 9 deletions
diff --git a/doc/emacs/search.texi b/doc/emacs/search.texi
index 2bd35380780..5f7aa1f1ef5 100644
--- a/doc/emacs/search.texi
+++ b/doc/emacs/search.texi
@@ -2202,24 +2202,20 @@ variable @code{isearch-lazy-highlight} to @code{nil} disables this
highlighting. Here are some other variables that customize the lazy
highlighting:
-@table @code
+@vtable @code
@item lazy-highlight-initial-delay
-@vindex lazy-highlight-initial-delay
Time in seconds to wait before highlighting visible matches.
Applies only if the search string is less than
@code{lazy-highlight-no-delay-length} characters long.
@item lazy-highlight-no-delay-length
-@vindex lazy-highlight-no-delay-length
For search strings at least as long as the value of this variable,
lazy highlighting of matches starts immediately.
@item lazy-highlight-interval
-@vindex lazy-highlight-interval
Time in seconds between highlighting successive matches.
@item lazy-highlight-max-at-a-time
-@vindex lazy-highlight-max-at-a-time
The maximum number of matches to highlight before checking for input.
A large number can take some time to highlight, so if you want to
continue searching and type @kbd{C-s} or @kbd{C-r} during that time,
@@ -2227,17 +2223,28 @@ Emacs will not respond until it finishes highlighting all those
matches. Thus, smaller values make Emacs more responsive.
@item isearch-lazy-count
-@vindex isearch-lazy-count
Show the current match number and the total number of matches in the
search prompt.
@item lazy-count-prefix-format
@itemx lazy-count-suffix-format
-@vindex lazy-count-prefix-format
-@vindex lazy-count-suffix-format
These two variables determine the format of showing the current and
the total number of matches for @code{isearch-lazy-count}.
-@end table
+
+@item lazy-highlight-buffer
+If non-@code{nil}, lazy highlighting highlights the matches in the
+entire buffer, not only those visible on display of the current window
+(so, for example, they will also become visible in other windows showing
+the same buffer).
+
+@item lazy-highlight-buffer-max-at-a-time
+Like @code{lazy-highlight-max-at-a-time}, but used for highlighting
+matches not currently visible in the window when
+@code{lazy-highlight-buffer} is non-@code{nil}. It defaults to 200; set
+to @code{nil} to highlight all the matches in a buffer without checking
+for input. @strong{Warning:} this could make Emacs not responsive when
+searching large buffers.
+@end vtable
@vindex search-nonincremental-instead
Normally, entering @key{RET} within incremental search when the