From: Eli Zaretskii <eliz@gnu.org>
Date: Fri, 16 Dec 2022 15:43:46 +0000 (+0200)
Subject: ; Add useful hint to which-func documentation
X-Git-Tag: emacs-29.0.90~1127
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=10415d9651b0c85f9d6585cb789100c239c532b4;p=emacs.git

; Add useful hint to which-func documentation

* lisp/progmodes/which-func.el (which-func-non-auto-modes)
(which-func-maxout): Mention the slow startup with Eglot and
how to work around that.  (Bug#60107)
---

diff --git a/lisp/progmodes/which-func.el b/lisp/progmodes/which-func.el
index 07050fb3d6b..8a90b6d26ea 100644
--- a/lisp/progmodes/which-func.el
+++ b/lisp/progmodes/which-func.el
@@ -78,12 +78,22 @@ then Which Function mode is enabled in any major mode that supports it."
 This means that Which Function mode won't really do anything
 until you use Imenu, in these modes.  Note that files
 larger than `which-func-maxout' behave in this way too;
-Which Function mode doesn't do anything until you use Imenu."
+Which Function mode doesn't do anything until you use Imenu.
+
+If Which Function delays the initial display of buffers too much,
+e.g., when it is used with Eglot, and the language server takes a
+long time to send the information, you can use this option to delay
+activation of Which Function until Imenu is used for the first time."
   :type '(repeat (symbol :tag "Major mode")))
 
 (defcustom which-func-maxout 500000
   "Don't automatically compute the Imenu menu if buffer is this big or bigger.
-Zero means compute the Imenu menu regardless of size."
+Zero means compute the Imenu menu regardless of size.
+
+If Which Function delays the initial display of buffers too much,
+e.g., when it is used with Eglot, and the language server takes a
+long time to send the information, you can use this option to delay
+activation of Which Function until Imenu is used for the first time."
   :type 'integer)
 
 (defvar which-func-keymap