bug#62708: [PATCH] Add option to control default outlining in C-h b

bug#62708: [PATCH] Add option to control default outlining in C-h b

[Eshel Yaron via Bug reports for GNU Emacs, the Swiss army knife of text editors]

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

Tags: patch

Hi,

The attached patch adds a user option `describe-bindings-outline-rules`
that is used in `describe-bindings` to as the local value of
`outline-default-rules`.  This replaces a currently hard-coded setting
that takes care of hiding "Key translations" to give users more control.
For example, to also have `pixel-scroll-precision-mode` bindings
initially hidden, one can set this option to:

'((match-regexp . "Key translations\\|pixel-scroll-precision-mode"))



In GNU Emacs 30.0.50 (build 1, x86_64-apple-darwin22.4.0, NS
 appkit-2299.50 Version 13.3 (Build 22E252)) of 2023-04-06 built on
 esmac
Repository revision: 5e5f5b28e92a3bb927bb03c783c426c6c3baeadc
Repository branch: master
Windowing system distributor 'Apple', version 10.3.2299
System Description:  macOS 13.3

Configured using:
 'configure CFLAGS=-O3 --with-native-compilation --with-json
 --with-tree-sitter'


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Add-option-to-control-default-outlining-in-C-h-b.patch --]
[-- Type: text/patch, Size: 2294 bytes --]

From ce5ef0c3760ba0f954779f9e52d41a1ff89c210b Mon Sep 17 00:00:00 2001
From: Eshel Yaron <me@eshelyaron.com>
Date: Fri, 7 Apr 2023 13:09:59 +0300
Subject: [PATCH] Add option to control default outlining in C-h b

* lisp/help.el (describe-bindings-outline-rules): new user option.
(describe-bindings): use it instead of hardcoding "Key translations".
---
 etc/NEWS     |  5 +++++
 lisp/help.el | 13 +++++++++++--
 2 files changed, 16 insertions(+), 2 deletions(-)

diff --git a/etc/NEWS b/etc/NEWS
index d20d9f65ac9..303b1e3c375 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -30,6 +30,11 @@ applies, and please also update docstrings as needed.
 \f
 * Changes in Emacs 30.1
 
+---
+** New user option 'describe-bindings-outline-rules'.
+This user option controls outline visibility in the output buffer of
+'describe-bindings' when 'describe-bindings-outline' in non-nil.
+
 ** X selection requests are now handled much faster and asynchronously.
 This means it should be less necessary to disable the likes of
 'select-active-regions' when Emacs is running over a slow network
diff --git a/lisp/help.el b/lisp/help.el
index 6eac037df2c..886c6e0acc8 100644
--- a/lisp/help.el
+++ b/lisp/help.el
@@ -727,6 +727,16 @@ describe-bindings-show-prefix-commands
   :group 'help
   :version "29.1")
 
+(defcustom describe-bindings-outline-rules '((match-regexp . "Key translations"))
+  "Visibility rules for outlines in the output buffer of `describe-bindings'.
+This is used as the value of `outline-default-rules' in the
+output buffer of `describe-bindings' when
+`describe-bindings-outline' is non-nil, otherwise this option
+doesn't have any effect."
+  :type 'boolean
+  :group 'help
+  :version "30.1")
+
 (declare-function outline-hide-subtree "outline")
 
 (defun describe-bindings (&optional prefix buffer)
@@ -756,8 +766,7 @@ describe-bindings
                       outline-minor-mode-use-buttons 'insert
                       ;; Hide the longest body.
                       outline-default-state 1
-                      outline-default-rules
-                      '((match-regexp . "Key translations")))
+                      outline-default-rules describe-bindings-outline-rules)
           (outline-minor-mode 1)
           (save-excursion
             (goto-char (point-min))
-- 
2.40.0

bug#62708: [PATCH] Add option to control default outlining in C-h b

[Eli Zaretskii]

> Date: Fri, 07 Apr 2023 13:37:56 +0300
> From:  Eshel Yaron via "Bug reports for GNU Emacs,
>  the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
> 
> The attached patch adds a user option `describe-bindings-outline-rules`
> that is used in `describe-bindings` to as the local value of
> `outline-default-rules`.  This replaces a currently hard-coded setting
> that takes care of hiding "Key translations" to give users more control.
> For example, to also have `pixel-scroll-precision-mode` bindings
> initially hidden, one can set this option to:
> 
> '((match-regexp . "Key translations\\|pixel-scroll-precision-mode"))

Thanks.

However, you already exhausted the amount of changes we can accept
from you without a copyright assignment.  Would you like to start your
assignment paperwork at this time?  Then we can accept this and other
contributions from you when the paperwork is done.

bug#62708: [PATCH] Add option to control default outlining in C-h b

[Eshel Yaron via Bug reports for GNU Emacs, the Swiss army knife of text editors]

Hello Eli,

Eli Zaretskii <eliz@gnu.org> writes:

> Thanks.
>
> However, you already exhausted the amount of changes we can accept
> from you without a copyright assignment.  Would you like to start your
> assignment paperwork at this time?  Then we can accept this and other
> contributions from you when the paperwork is done.

I understand.  I have the required documents ready and I /thought/ sent
them over already several weeks ago.  I didn't get a confirmation
though.  Anyway, I've just sent my paperwork again so I hope it'll be in
order soon.

bug#62708: [PATCH] Add option to control default outlining in C-h b

[Eshel Yaron via Bug reports for GNU Emacs, the Swiss army knife of text editors]

Eshel Yaron <me@eshelyaron.com> writes:

> Hello Eli,
>
> Eli Zaretskii <eliz@gnu.org> writes:
>
>> Thanks.
>>
>> However, you already exhausted the amount of changes we can accept
>> from you without a copyright assignment.  Would you like to start your
>> assignment paperwork at this time?  Then we can accept this and other
>> contributions from you when the paperwork is done.
>
> I understand.  I have the required documents ready and I /thought/ sent
> them over already several weeks ago.  I didn't get a confirmation
> though.  Anyway, I've just sent my paperwork again so I hope it'll be in
> order soon.

FYI I've received confirmation that my copyright assignment is done, so
hopefully that's no longer an issue.  Any comments about the patch itself?

Thanks,
Eshel

bug#62708: [PATCH] Add option to control default outlining in C-h b

[Eli Zaretskii]

> From: Eshel Yaron <me@eshelyaron.com>
> Cc: 62708@debbugs.gnu.org
> Date: Fri, 21 Apr 2023 18:57:21 +0300
> 
> FYI I've received confirmation that my copyright assignment is done, so
> hopefully that's no longer an issue.

Right.

> Any comments about the patch itself?

Juri, any comments, or should I install it?

bug#62708: [PATCH] Add option to control default outlining in C-h b

[Juri Linkov]

>> FYI I've received confirmation that my copyright assignment is done, so
>> hopefully that's no longer an issue.
>
> Right.
>
>> Any comments about the patch itself?
>
> Juri, any comments, or should I install it?

It's nice that the patch makes the currently hard-coded setting
customizable.  Usually we strive to reduce the number of user options,
but here I see no other easy way to make this setting customizable
because there is no hook run from this command where the users
could override the default outline settings.

bug#62708: [PATCH] Add option to control default outlining in C-h b

[Eli Zaretskii]

> From: Juri Linkov <juri@linkov.net>
> Cc: Eshel Yaron <me@eshelyaron.com>,  62708@debbugs.gnu.org
> Date: Sun, 23 Apr 2023 19:35:01 +0300
> 
> >> FYI I've received confirmation that my copyright assignment is done, so
> >> hopefully that's no longer an issue.
> >
> > Right.
> >
> >> Any comments about the patch itself?
> >
> > Juri, any comments, or should I install it?
> 
> It's nice that the patch makes the currently hard-coded setting
> customizable.  Usually we strive to reduce the number of user options,
> but here I see no other easy way to make this setting customizable
> because there is no hook run from this command where the users
> could override the default outline settings.

Thanks, installed on master, and closing the bug.

Yaron, please in the future observe our conventions for commit log
messages (I made the few minor changes they needed this time).

bug#62708: [PATCH] Add option to control default outlining in C-h b

[Eshel Yaron via Bug reports for GNU Emacs, the Swiss army knife of text editors]

Eli Zaretskii <eliz@gnu.org> writes:

>> From: Juri Linkov <juri@linkov.net>
>> Cc: Eshel Yaron <me@eshelyaron.com>,  62708@debbugs.gnu.org
>> Date: Sun, 23 Apr 2023 19:35:01 +0300
>> 
>> >> FYI I've received confirmation that my copyright assignment is done, so
>> >> hopefully that's no longer an issue.
>> >
>> > Right.
>> >
>> >> Any comments about the patch itself?
>> >
>> > Juri, any comments, or should I install it?
>> 
>> It's nice that the patch makes the currently hard-coded setting
>> customizable.  Usually we strive to reduce the number of user options,
>> but here I see no other easy way to make this setting customizable
>> because there is no hook run from this command where the users
>> could override the default outline settings.
>
> Thanks, installed on master, and closing the bug.

Great.

> Yaron,

It's Eshel, Yaron is my surname.
(I get that a lot though, no worries.)

> please in the future observe our conventions for commit log
> messages (I made the few minor changes they needed this time).

Thanks, will do.  I've compared my patch to the installed commit and
made note of your changes.