From: Theodor Thornhill <theo@thornhill.no>
Date: Wed, 17 Apr 2024 18:27:35 +0000 (+0200)
Subject: Document earlier change in eglot-report-progress
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=49c552cd07d71d0330daf7c1406058a81e7c4d1e;p=emacs.git

Document earlier change in eglot-report-progress

* lisp/progmodes/eglot.el (eglot-report-progress): Document the changed
behavior.
* etc/EGLOT-NEWS (https): Mention the change.

(cherry picked from commit 0dbd9ed04660152276696e462359204a45ca933d)
---

diff --git a/etc/EGLOT-NEWS b/etc/EGLOT-NEWS
index 12e7d3f6b9b..0e3e4b7aff8 100644
--- a/etc/EGLOT-NEWS
+++ b/etc/EGLOT-NEWS
@@ -20,6 +20,12 @@ https://github.com/joaotavora/eglot/issues/1234.
 
 * Changes in upcoming Eglot
 
+** Disable workDoneProgress if eglot-report-progress is nil
+
+Eglot will now try to not register $/progress messages from the server
+when the defcustom is set to nil.  This requires a restart of the server
+for the change to take effect.
+
 
 * Changes in Eglot 1.17 (25/1/2024)
 
diff --git a/lisp/progmodes/eglot.el b/lisp/progmodes/eglot.el
index 46b17de5f98..5bac6a5163f 100644
--- a/lisp/progmodes/eglot.el
+++ b/lisp/progmodes/eglot.el
@@ -517,7 +517,10 @@ ACTION is the default value for commands not in the alist."
 (defcustom eglot-report-progress t
   "If non-nil, show progress of long running LSP server work.
 If set to `messages', use *Messages* buffer, else use Eglot's
-mode line indicator."
+mode line indicator.
+
+For changes on this variable to take effect, you need to restart
+the LSP connection.  That can be done by `eglot-reconnect'."
   :type '(choice (const :tag "Don't show progress" nil)
                  (const :tag "Show progress in *Messages*" messages)
                  (const :tag "Show progress in Eglot's mode line indicator" t))