From: Eli Zaretskii <eliz@gnu.org>
Date: Thu, 8 Feb 2024 06:56:42 +0000 (+0200)
Subject: ; Improve documentation of 'echo-keystrokes-help'
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=7688260278ebf9b610266fd9de65838a9a9f0a23;p=emacs.git

; Improve documentation of 'echo-keystrokes-help'

* doc/emacs/display.texi (Display Custom): Document
'echo-keystrokes-help'.

* etc/NEWS: Mark the 'echo-keystrokes-help' entry documented.

(cherry picked from commit d6c7092ff0713087f38b9492d53be0177af67514)
---

diff --git a/doc/emacs/display.texi b/doc/emacs/display.texi
index 6db9e8344c6..d2557d6148e 100644
--- a/doc/emacs/display.texi
+++ b/doc/emacs/display.texi
@@ -2210,6 +2210,13 @@ keys; its value is the number of seconds of pause required to cause echoing
 to start, or zero, meaning don't echo at all.  The value takes effect when
 there is something to echo.  @xref{Echo Area}.
 
+@vindex echo-keystrokes-help
+  If the variable @code{echo-keystrokes-help} is non-@code{nil} (the
+default), the multi-character key sequence echo shown according to
+@code{echo-keystrokes} will include a short help text about keys which
+will invoke @code{describe-prefix-bindings} (@pxref{Misc Help}) to show
+the list of commands for the prefix you already typed.
+
 @cindex mouse pointer
 @cindex hourglass pointer display
 @vindex display-hourglass
diff --git a/etc/NEWS b/etc/NEWS
index dc62fdbb9bf..661267a0150 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -305,7 +305,8 @@ between the auto save file and the current file.
 ** 'ffap-lax-url' now defaults to nil.
 Previously, it was set to t but this broke remote file name detection.
 
-** Unfinished commands' echo now ends with a suggestion to use Help.
++++
+** Multi-character key echo now ends with a suggestion to use Help.
 Customize 'echo-keystrokes-help' to nil to prevent that.