bug#62279: Add an option to restore C-h b "Prefix Command" output

bug#62279: Add an option to restore C-h b "Prefix Command" output

[Bob Rogers]

[-- Attachment #1: Type: text/plain, Size: 639 bytes --]

Tags: patch

   Pursuant to the 'No more "Prefix Command" in C-h m' discussion in the
emacs-devel list.

					-- Bob Rogers
					   http://www.rgrjr.com/

In GNU Emacs 30.0.50 (build 1, x86_64-pc-linux-gnu, GTK+ Version
 3.24.34, cairo version 1.16.0) of 2023-03-13 built on orion
Repository revision: a79d209748857c7d63ac48a7172a89e5ad1e752b
Repository branch: rgr-smtpmail-env-from
Windowing system distributor 'The X.Org Foundation', version 11.0.12003000
System Description: openSUSE Leap 15.4

Configured using:
 'configure --with-dbus=no --with-gsettings=no --with-gif=ifavailable
 --with-tiff=no --with-gnutls=yes --with-gconf=no'


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: describe-bindings-show-prefixes-2.patch --]
[-- Type: text/patch, Size: 1631 bytes --]

Add an option to restore C-h b "Prefix Command" output

* lisp/help.el (describe-bindings-show-prefixes):  Option to enable prefixes.
(describe-map):  If true, restore "Prefix Command" output.
* etc/NEWS:  Describe the new option.

diff --git a/etc/NEWS b/etc/NEWS
index 3b02e85b691..5a4a038e953 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -61,6 +61,11 @@ This allows the user to customize the prompt that is appended by
 This is used for displaying the time and date components of
 'display-time-mode'.
 
+** New user option 'describe-bindings-show-prefixes'.
+If true (the default is false), restores the "Prefix Command" entries
+in 'describe-binding' ('C-h b') output for keys that are prefixes, the
+details of which are shown later (regardless of this option setting).
+
 \f
 * Editing Changes in Emacs 30.1
 
diff --git a/lisp/help.el b/lisp/help.el
index 83be85b1ee4..37a08718f9d 100644
--- a/lisp/help.el
+++ b/lisp/help.el
@@ -717,6 +717,12 @@ describe-bindings-outline
   :group 'help
   :version "29.1")
 
+(defcustom describe-bindings-show-prefixes nil
+  "Non-nil shows prefixes in the output buffer of `describe-bindings'."
+  :type 'boolean
+  :group 'help
+  :version "30.1")
+
 (declare-function outline-hide-subtree "outline")
 
 (defun describe-bindings (&optional prefix buffer)
@@ -1699,6 +1705,7 @@ describe-map
               (setq vect (cdr vect))
               (setq end (caar vect))))
           (when (or (not (eq start end))
+                    describe-bindings-show-prefixes
                     ;; Don't output keymap prefixes.
                     (not (keymapp definition)))
             (when first

bug#62279: Add an option to restore C-h b "Prefix Command" output

[Eli Zaretskii]

> From: Bob Rogers <rogers@rgrjr.com>
> Date: Sun, 19 Mar 2023 12:26:46 -0700
> 
>    Pursuant to the 'No more "Prefix Command" in C-h m' discussion in the
> emacs-devel list.

Thanks.

> --- a/etc/NEWS
> +++ b/etc/NEWS
> @@ -61,6 +61,11 @@ This allows the user to customize the prompt that is appended by
>  This is used for displaying the time and date components of
>  'display-time-mode'.
>  
> +** New user option 'describe-bindings-show-prefixes'.
> +If true (the default is false), restores the "Prefix Command" entries

We use "If non-nil", not "If true".  And similarly for "false".

> +in 'describe-binding' ('C-h b') output for keys that are prefixes, the
> +details of which are shown later (regardless of this option setting).

This NEWS entry should go to where the change in "C-h b"s behavior is
described in NEWS (on emacs-29 branch), and should be reworded to tell
users how to get the previous behavior back ("To get the previous
behavior back, customize ...").

> +(defcustom describe-bindings-show-prefixes nil
> +  "Non-nil shows prefixes in the output buffer of `describe-bindings'."
> +  :type 'boolean
> +  :group 'help
> +  :version "30.1")

This should be "29.1".  Since the behavior change was introduced in
Emacs 29, we need to add this option in the same version.

bug#62279: Add an option to restore C-h b "Prefix Command" output

[Bob Rogers]

[-- Attachment #1: message body text --]
[-- Type: text/plain, Size: 1686 bytes --]

   From: Eli Zaretskii <eliz@gnu.org>
   Date: Sun, 19 Mar 2023 21:35:37 +0200

   > From: Bob Rogers <rogers@rgrjr.com>
   > Date: Sun, 19 Mar 2023 12:26:46 -0700
   > 
   >    Pursuant to the 'No more "Prefix Command" in C-h m' discussion in the
   > emacs-devel list.

   Thanks.

   > --- a/etc/NEWS
   > +++ b/etc/NEWS
   > @@ -61,6 +61,11 @@ This allows the user to customize the prompt that is appended by
   >  This is used for displaying the time and date components of
   >  'display-time-mode'.
   >  
   > +** New user option 'describe-bindings-show-prefixes'.
   > +If true (the default is false), restores the "Prefix Command" entries

   We use "If non-nil", not "If true".  And similarly for "false".

Guess I've been thinking too much in Perl lately.  ;-}

   > +in 'describe-binding' ('C-h b') output for keys that are prefixes, the
   > +details of which are shown later (regardless of this option setting).

   This NEWS entry should go to where the change in "C-h b"s behavior is
   described in NEWS (on emacs-29 branch), and should be reworded to tell
   users how to get the previous behavior back ("To get the previous
   behavior back, customize ...").

OK.  I also subordinated it to the "Keymap descriptions have changed"
entry, since that seemed apt.

   > +(defcustom describe-bindings-show-prefixes nil
   > +  "Non-nil shows prefixes in the output buffer of `describe-bindings'."
   > +  :type 'boolean
   > +  :group 'help
   > +  :version "30.1")

   This should be "29.1".  Since the behavior change was introduced in
   Emacs 29, we need to add this option in the same version.

OK, I wasn't sure Lars' change actually made it into 29.

					-- Bob


[-- Attachment #2: describe-bindings-show-prefixes-3.patch --]
[-- Type: text/x-patch, Size: 1667 bytes --]

Add an option to restore C-h b "Prefix Command" output

* lisp/help.el (describe-bindings-show-prefixes):  Option to enable prefixes.
(describe-map):  If true, restore "Prefix Command" output.
* etc/NEWS:  Describe the new option.

diff --git a/etc/NEWS b/etc/NEWS
index a5f9f8c6ec1..c4e16221d72 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -3563,6 +3563,10 @@ keymap descriptions have changed.  In particular, prefix commands are
 not output at all, and instead of "??" for closures/functions,
 "[closure]"/"[lambda]" is output.
 
+*** New user option 'describe-bindings-show-prefixes'.
+To reinstate the "Prefix Command" entries in key binding output for
+keys that are prefixes, set this option non-nil (the default is nil).
+
 ---
 ** 'downcase' details have changed slightly.
 In certain locales, changing the case of an ASCII-range character may
diff --git a/lisp/help.el b/lisp/help.el
index 83be85b1ee4..3e450fe0763 100644
--- a/lisp/help.el
+++ b/lisp/help.el
@@ -717,6 +717,12 @@ describe-bindings-outline
   :group 'help
   :version "29.1")
 
+(defcustom describe-bindings-show-prefixes nil
+  "Non-nil shows prefixes in the output buffer of `describe-bindings'."
+  :type 'boolean
+  :group 'help
+  :version "29.1")
+
 (declare-function outline-hide-subtree "outline")
 
 (defun describe-bindings (&optional prefix buffer)
@@ -1699,6 +1705,7 @@ describe-map
               (setq vect (cdr vect))
               (setq end (caar vect))))
           (when (or (not (eq start end))
+                    describe-bindings-show-prefixes
                     ;; Don't output keymap prefixes.
                     (not (keymapp definition)))
             (when first

bug#62279: Add an option to restore C-h b "Prefix Command" output

[Eli Zaretskii]

> From: Bob Rogers <rogers@rgrjr.com>
> Date: Sun, 19 Mar 2023 12:59:45 -0700
> CC: 62279@debbugs.gnu.org
> 
>    From: Eli Zaretskii <eliz@gnu.org>
>    Date: Sun, 19 Mar 2023 21:35:37 +0200
> 
>    > From: Bob Rogers <rogers@rgrjr.com>
>    > Date: Sun, 19 Mar 2023 12:26:46 -0700
>    > 
>    >    Pursuant to the 'No more "Prefix Command" in C-h m' discussion in the
>    > emacs-devel list.
> 
>    Thanks.
> 
>    > --- a/etc/NEWS
>    > +++ b/etc/NEWS
>    > @@ -61,6 +61,11 @@ This allows the user to customize the prompt that is appended by
>    >  This is used for displaying the time and date components of
>    >  'display-time-mode'.
>    >  
>    > +** New user option 'describe-bindings-show-prefixes'.
>    > +If true (the default is false), restores the "Prefix Command" entries
> 
>    We use "If non-nil", not "If true".  And similarly for "false".
> 
> Guess I've been thinking too much in Perl lately.  ;-}
> 
>    > +in 'describe-binding' ('C-h b') output for keys that are prefixes, the
>    > +details of which are shown later (regardless of this option setting).
> 
>    This NEWS entry should go to where the change in "C-h b"s behavior is
>    described in NEWS (on emacs-29 branch), and should be reworded to tell
>    users how to get the previous behavior back ("To get the previous
>    behavior back, customize ...").
> 
> OK.  I also subordinated it to the "Keymap descriptions have changed"
> entry, since that seemed apt.
> 
>    > +(defcustom describe-bindings-show-prefixes nil
>    > +  "Non-nil shows prefixes in the output buffer of `describe-bindings'."
>    > +  :type 'boolean
>    > +  :group 'help
>    > +  :version "30.1")
> 
>    This should be "29.1".  Since the behavior change was introduced in
>    Emacs 29, we need to add this option in the same version.
> 
> OK, I wasn't sure Lars' change actually made it into 29.

Thanks, I've now installed this (with some minor changes) on the
emacs-29 branch, and I'm therefore closing this bug.