summaryrefslogtreecommitdiff
path: root/lisp/imenu.el
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2022-05-12 09:16:24 +0300
committerEli Zaretskii <eliz@gnu.org>2022-05-12 09:16:24 +0300
commitba20b68d558e67fe72cb47398e4decf261c45d7a (patch)
tree156561e21671a7d0f24b64b8de02082032cc63be /lisp/imenu.el
parentec1a14ab331c0abc57bc34972a8a6f69c6ffa17a (diff)
downloademacs-ba20b68d558e67fe72cb47398e4decf261c45d7a.tar.gz
; Improve documentation of 'imenu-flush-cache'
* etc/NEWS: Expand the description of 'imenu-flush-cache'. * doc/emacs/programs.texi (Imenu): Document 'imenu-flush-cache'. * lisp/imenu.el (imenu-flush-cache): Doc fix. (Bug#20589)
Diffstat (limited to 'lisp/imenu.el')
-rw-r--r--lisp/imenu.el4
1 files changed, 3 insertions, 1 deletions
diff --git a/lisp/imenu.el b/lisp/imenu.el
index e452b1bb8b9..a08c58f6825 100644
--- a/lisp/imenu.el
+++ b/lisp/imenu.el
@@ -900,7 +900,9 @@ for more information."
(_ (error "Unknown imenu item: %S" index-item)))))
(defun imenu-flush-cache ()
- "Flush the current imenu cache."
+ "Flush the current imenu cache.
+This forces a full rescan of the buffer to recreate the index alist
+next time `imenu' is invoked."
(interactive)
(setq imenu--index-alist nil)
(message "Flushed the imenu cache"))