Re: master fa4203300fd: Merge remote-tracking branch 'origin/feature/which-key-in-core'

Re: master fa4203300fd: Merge remote-tracking branch 'origin/feature/which-key-in-core'

[Robert Pluim]

>>>>> On Tue, 18 Jun 2024 15:46:35 -0400 (EDT), Philip Kaludercic <philipk@posteo.net> said:

    Philip> +
    Philip> ++++
    Philip> +** New package Which-Key
    Philip> +The 'which-key' package from GNU ELPA is now included in Emacs.  It
    Philip> +implements the 'which-key-mode' that displays a table of key bindings
    Philip> +upon entering a partial key chord and waiting for a moment.
    Philip> +

This doesnʼt appear to work for the "iso-transl" key bindings, but
then again Iʼm not sure it should :-)

Robert
-- 

Re: master fa4203300fd: Merge remote-tracking branch 'origin/feature/which-key-in-core'

[Philip Kaludercic]

Robert Pluim <rpluim@gmail.com> writes:

>>>>>> On Tue, 18 Jun 2024 15:46:35 -0400 (EDT), Philip Kaludercic <philipk@posteo.net> said:
>
>     Philip> +
>     Philip> ++++
>     Philip> +** New package Which-Key
>     Philip> +The 'which-key' package from GNU ELPA is now included in Emacs.  It
>     Philip> +implements the 'which-key-mode' that displays a table of key bindings
>     Philip> +upon entering a partial key chord and waiting for a moment.
>     Philip> +
>
> This doesnʼt appear to work for the "iso-transl" key bindings, but
> then again Iʼm not sure it should :-)

I am not sure what bindings you have in mind specifically.  While I
don't really have a good, global understanding of which-key, I can try
to look into the issue (if it is one), if you give me something to test.

> Robert

-- 
	Philip Kaludercic on peregrine

Re: master fa4203300fd: Merge remote-tracking branch 'origin/feature/which-key-in-core'

[Robert Pluim]

>>>>> On Wed, 19 Jun 2024 07:42:16 +0000, Philip Kaludercic <philipk@posteo.net> said:

    Philip> Robert Pluim <rpluim@gmail.com> writes:
    >>>>>>> On Tue, 18 Jun 2024 15:46:35 -0400 (EDT), Philip Kaludercic <philipk@posteo.net> said:
    >> 
    Philip> +
    Philip> ++++
    Philip> +** New package Which-Key
    Philip> +The 'which-key' package from GNU ELPA is now included in Emacs.  It
    Philip> +implements the 'which-key-mode' that displays a table of key bindings
    Philip> +upon entering a partial key chord and waiting for a moment.
    Philip> +
    >> 
    >> This doesnʼt appear to work for the "iso-transl" key bindings, but
    >> then again Iʼm not sure it should :-)

    Philip> I am not sure what bindings you have in mind specifically.  While I
    Philip> don't really have a good, global understanding of which-key, I can try
    Philip> to look into the issue (if it is one), if you give me something to test.

Iʼm thinking of stuff like 'C-x 8 * E'. Itʼs possible to argue that
doesnʼt qualify as a 'key binding', since its entire purpose is to
enter a specific character, not run a command.

Robert
-- 

Re: master fa4203300fd: Merge remote-tracking branch 'origin/feature/which-key-in-core'

[Robert Pluim]

>>>>> On Wed, 19 Jun 2024 10:49:41 +0200, Robert Pluim <rpluim@gmail.com> said:

>>>>> On Wed, 19 Jun 2024 07:42:16 +0000, Philip Kaludercic <philipk@posteo.net> said:
    Philip> Robert Pluim <rpluim@gmail.com> writes:
    >>>>>>>> On Tue, 18 Jun 2024 15:46:35 -0400 (EDT), Philip Kaludercic <philipk@posteo.net> said:
    >>> 
    Philip> +
    Philip> ++++
    Philip> +** New package Which-Key
    Philip> +The 'which-key' package from GNU ELPA is now included in Emacs.  It
    Philip> +implements the 'which-key-mode' that displays a table of key bindings
    Philip> +upon entering a partial key chord and waiting for a moment.
    Philip> +
    >>> 
    >>> This doesnʼt appear to work for the "iso-transl" key bindings, but
    >>> then again Iʼm not sure it should :-)

    Philip> I am not sure what bindings you have in mind specifically.  While I
    Philip> don't really have a good, global understanding of which-key, I can try
    Philip> to look into the issue (if it is one), if you give me something to test.

    Robert> Iʼm thinking of stuff like 'C-x 8 * E'. Itʼs possible to argue that
    Robert> doesnʼt qualify as a 'key binding', since its entire purpose is to
    Robert> enter a specific character, not run a command.

This patch does it, now we just need to decide if we want to do it,
and if so, should there be a user option to enable it? Perhaps
`function-key-map' should not be consulted.

(are we planning to turn `which-key-mode' on by default? Personally I
wouldnʼt mind, but itʼs a change in default behaviour, which tends to
annoy people)

@@ -1942,8 +1949,10 @@ which-key--get-keymap-bindings
 
 (defun which-key--get-current-bindings (&optional prefix filter)
   "Generate a list of current active bindings."
-  (let (bindings)
-    (dolist (map (current-active-maps t) bindings)
+  (let (bindings
+        (maps (nconc (current-active-maps t)
+                     (list key-translation-map function-key-map))))
+    (dolist (map maps bindings)
       (when (cdr map)
         (setq bindings
               (which-key--get-keymap-bindings

Robert
-- 

Re: master fa4203300fd: Merge remote-tracking branch 'origin/feature/which-key-in-core'

[Stefan Kangas]

Robert Pluim <rpluim@gmail.com> writes:

> This patch does it, now we just need to decide if we want to do it,
> and if so, should there be a user option to enable it? Perhaps
> `function-key-map' should not be consulted.
>
> (are we planning to turn `which-key-mode' on by default? Personally I
> wouldnʼt mind, but itʼs a change in default behaviour, which tends to
> annoy people)

AFAIK, no one has proposed doing that for Emacs 30.  Emacs 31 is still
up for discussion, I assume.

Enabling it by default could only be done after careful consideration.
I proposed enabling it back in 2020, and I still agree with what Stefan
Monnier said back then:

> I think it would be most useful to enable it by default.
> But for that it needs to be polished enough that it's still bearable for
> those users who don't like it (e.g. the guy with his 1MB .emacs file
> that has to use a `emacs -Q` when testing something, or when using
> Emacs on someone else's computer/account).

From my point of view, having it in core is already a step in the right
direction.  For now, I'd recommend that people check out the state it's
currently in on master, and report any issues they see.

Re: master fa4203300fd: Merge remote-tracking branch 'origin/feature/which-key-in-core'

[Robert Pluim]

>>>>> On Wed, 19 Jun 2024 12:33:55 +0000, Stefan Kangas <stefankangas@gmail.com> said:
    Stefan> Enabling it by default could only be done after careful consideration.
    Stefan> I proposed enabling it back in 2020, and I still agree with what Stefan
    Stefan> Monnier said back then:

    >> I think it would be most useful to enable it by default.
    >> But for that it needs to be polished enough that it's still bearable for
    >> those users who don't like it (e.g. the guy with his 1MB .emacs file
    >> that has to use a `emacs -Q` when testing something, or when using
    >> Emacs on someone else's computer/account).

'emacs -Q' already annoys the crap out of me because of my missing
customizations, so one more change would make no difference 😺

    Stefan> From my point of view, having it in core is already a step in the right
    Stefan> direction.  For now, I'd recommend that people check out the state it's
    Stefan> currently in on master, and report any issues they see.

I can try it, although perhaps I am not the target market.

Robert
-- 

Re: master fa4203300fd: Merge remote-tracking branch 'origin/feature/which-key-in-core'

[Philip Kaludercic]

Robert Pluim <rpluim@gmail.com> writes:

> (are we planning to turn `which-key-mode' on by default? Personally I
> wouldnʼt mind, but itʼs a change in default behaviour, which tends to
> annoy people)

I am against it.  The way I see it, which-key-mode are like trailing
wheels.  I know that I'm faster using C-h b C-s.  While testing
Which-Key, I frequently was annoyed that the only time the buffer popped
up was when I paused mid keychord, because I was distracted or was
thinking about what I wanted to do, /not/ because I didn't know what I
can do.

Generally speaking using a timeout to trigger an specific behaviour is
also unlike anything that we have OOTB, if I am not mistaken.

-- 
	Philip Kaludercic on peregrine

Re: master fa4203300fd: Merge remote-tracking branch 'origin/feature/which-key-in-core'

[Eli Zaretskii]

> From: Robert Pluim <rpluim@gmail.com>
> Cc: emacs-devel@gnu.org
> Date: Wed, 19 Jun 2024 14:01:07 +0200
> 
> >>>>> On Wed, 19 Jun 2024 10:49:41 +0200, Robert Pluim <rpluim@gmail.com> said:
> 
> >>>>> On Wed, 19 Jun 2024 07:42:16 +0000, Philip Kaludercic <philipk@posteo.net> said:
>     Philip> Robert Pluim <rpluim@gmail.com> writes:
>     >>>>>>>> On Tue, 18 Jun 2024 15:46:35 -0400 (EDT), Philip Kaludercic <philipk@posteo.net> said:
>     >>> 
>     Philip> +
>     Philip> ++++
>     Philip> +** New package Which-Key
>     Philip> +The 'which-key' package from GNU ELPA is now included in Emacs.  It
>     Philip> +implements the 'which-key-mode' that displays a table of key bindings
>     Philip> +upon entering a partial key chord and waiting for a moment.
>     Philip> +
>     >>> 
>     >>> This doesnʼt appear to work for the "iso-transl" key bindings, but
>     >>> then again Iʼm not sure it should :-)
> 
>     Philip> I am not sure what bindings you have in mind specifically.  While I
>     Philip> don't really have a good, global understanding of which-key, I can try
>     Philip> to look into the issue (if it is one), if you give me something to test.
> 
>     Robert> Iʼm thinking of stuff like 'C-x 8 * E'. Itʼs possible to argue that
>     Robert> doesnʼt qualify as a 'key binding', since its entire purpose is to
>     Robert> enter a specific character, not run a command.
> 
> This patch does it, now we just need to decide if we want to do it,
> and if so, should there be a user option to enable it? Perhaps
> `function-key-map' should not be consulted.

What's the downside of doing this unconditionally?

> are we planning to turn `which-key-mode' on by default?

Not in Emacs 30, no.

Re: master fa4203300fd: Merge remote-tracking branch 'origin/feature/which-key-in-core'

[Robert Pluim]

>>>>> On Wed, 19 Jun 2024 16:10:23 +0300, Eli Zaretskii <eliz@gnu.org> said:
    >> This patch does it, now we just need to decide if we want to do it,
    >> and if so, should there be a user option to enable it? Perhaps
    >> `function-key-map' should not be consulted.

    Eli> What's the downside of doing this unconditionally?

You get a lot more bindings showing up, but only when doing 'C-x
8'. But letʼs discuss in the bug.

Robert
-- 

Re: master fa4203300fd: Merge remote-tracking branch 'origin/feature/which-key-in-core'

[tomas]

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

On Wed, Jun 19, 2024 at 04:10:23PM +0300, Eli Zaretskii wrote:

[...]

> What's the downside of doing this unconditionally?

You mean enabling "which-key" unconditionally?

Perhaps I'm misunderstanding, but I sure would want to switch it off.

Cheers
-- 
t

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 195 bytes --]

Re: master fa4203300fd: Merge remote-tracking branch 'origin/feature/which-key-in-core'

[Robert Pluim]

>>>>> On Wed, 19 Jun 2024 15:37:20 +0200, <tomas@tuxteam.de> said:

    Tomas> On Wed, Jun 19, 2024 at 04:10:23PM +0300, Eli Zaretskii wrote:
    Tomas> [...]

    >> What's the downside of doing this unconditionally?

    Tomas> You mean enabling "which-key" unconditionally?

    Tomas> Perhaps I'm misunderstanding, but I sure would want to switch it off.

Eli meant showing translation keybindings when which-key is enabled.

Robert
-- 

Re: master fa4203300fd: Merge remote-tracking branch 'origin/feature/which-key-in-core'

[tomas]

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

On Wed, Jun 19, 2024 at 03:43:52PM +0200, Robert Pluim wrote:

[...]

>     Tomas> Perhaps I'm misunderstanding, but I sure would want to switch it off.
> 
> Eli meant showing translation keybindings when which-key is enabled.

Thanks, makes sense. Sorry for the noise, then.

Cheers
-- 
t

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 195 bytes --]

Re: master fa4203300fd: Merge remote-tracking branch 'origin/feature/which-key-in-core'

[Eli Zaretskii]

> Date: Wed, 19 Jun 2024 15:37:20 +0200
> Cc: Robert Pluim <rpluim@gmail.com>, philipk@posteo.net,
> 	emacs-devel@gnu.org
> From:  <tomas@tuxteam.de>
> 
> On Wed, Jun 19, 2024 at 04:10:23PM +0300, Eli Zaretskii wrote:
> 
> [...]
> 
> > What's the downside of doing this unconditionally?
> 
> You mean enabling "which-key" unconditionally?

No, showing keys from other maps.  That's what you were suggesting to
have an option for, no?  The option for turning on and off which-key
already exists, so discussing its necessity sounds redundant, no?

Re: master fa4203300fd: Merge remote-tracking branch 'origin/feature/which-key-in-core'

[tomas]

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

On Wed, Jun 19, 2024 at 05:41:13PM +0300, Eli Zaretskii wrote:

[...]

> > You mean enabling "which-key" unconditionally?
> 
> No, showing keys from other maps.  That's what you were suggesting to
> have an option for, no?  The option for turning on and off which-key
> already exists, so discussing its necessity sounds redundant, no?

It is. I misunderstood, sorry.

Cheers
-- 
t

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 195 bytes --]

Re: master fa4203300fd: Merge remote-tracking branch 'origin/feature/which-key-in-core'

[Eli Zaretskii]

> From: Philip Kaludercic <philipk@posteo.net>
> Cc: emacs-devel@gnu.org
> Date: Wed, 19 Jun 2024 07:42:16 +0000
> 
> Robert Pluim <rpluim@gmail.com> writes:
> 
> >>>>>> On Tue, 18 Jun 2024 15:46:35 -0400 (EDT), Philip Kaludercic <philipk@posteo.net> said:
> >
> >     Philip> +
> >     Philip> ++++
> >     Philip> +** New package Which-Key
> >     Philip> +The 'which-key' package from GNU ELPA is now included in Emacs.  It
> >     Philip> +implements the 'which-key-mode' that displays a table of key bindings
> >     Philip> +upon entering a partial key chord and waiting for a moment.
> >     Philip> +
> >
> > This doesnʼt appear to work for the "iso-transl" key bindings, but
> > then again Iʼm not sure it should :-)
> 
> I am not sure what bindings you have in mind specifically.  While I
> don't really have a good, global understanding of which-key, I can try
> to look into the issue (if it is one), if you give me something to test.

Please do that via bug reports, not here.  We will have enough time to
fix the bugs before Emacs 30 is released, so there's no reason to
hurry, and let's do it right.

TIA

Re: master fa4203300fd: Merge remote-tracking branch 'origin/feature/which-key-in-core'

[Robert Pluim]

>>>>> On Wed, 19 Jun 2024 14:57:25 +0300, Eli Zaretskii <eliz@gnu.org> said:

    >> From: Philip Kaludercic <philipk@posteo.net>
    >> Cc: emacs-devel@gnu.org
    >> Date: Wed, 19 Jun 2024 07:42:16 +0000
    >> 
    >> Robert Pluim <rpluim@gmail.com> writes:
    >> 
    >> >>>>>> On Tue, 18 Jun 2024 15:46:35 -0400 (EDT), Philip Kaludercic <philipk@posteo.net> said:
    >> >
    >> >     Philip> +
    >> >     Philip> ++++
    >> >     Philip> +** New package Which-Key
    >> >     Philip> +The 'which-key' package from GNU ELPA is now included in Emacs.  It
    >> >     Philip> +implements the 'which-key-mode' that displays a table of key bindings
    >> >     Philip> +upon entering a partial key chord and waiting for a moment.
    >> >     Philip> +
    >> >
    >> > This doesnʼt appear to work for the "iso-transl" key bindings, but
    >> > then again Iʼm not sure it should :-)
    >> 
    >> I am not sure what bindings you have in mind specifically.  While I
    >> don't really have a good, global understanding of which-key, I can try
    >> to look into the issue (if it is one), if you give me something to test.

    Eli> Please do that via bug reports, not here.  We will have enough time to
    Eli> fix the bugs before Emacs 30 is released, so there's no reason to
    Eli> hurry, and let's do it right.

bug@71648 opened

Robert
-- 

Re: master fa4203300fd: Merge remote-tracking branch 'origin/feature/which-key-in-core'

[Michael Albinus]

Philip Kaludercic <philipk@posteo.net> writes:

> branch: master
> commit fa4203300fde6820a017bf1089652fb95759d68c
> Merge: a7dff8c53dd cc0a3a5f65b
> Author: Philip Kaludercic <philipk@posteo.net>
> Commit: Philip Kaludercic <philipk@posteo.net>
>
>     Merge remote-tracking branch 'origin/feature/which-key-in-core'
> ---
>  etc/NEWS                     |    7 +
>  lisp/which-key.el            | 2814 ++++++++++++++++++++++++++++++++++++++++++
>  test/lisp/which-key-tests.el |  267 ++++
>  3 files changed, 3088 insertions(+)

Seen in the emacs-30 branch:

--8<---------------cut here---------------start------------->8---
# make -C test test-custom-opts
...
The following options might have problems:
variable: which-key-separator
   value: nil
    type: (string)
variable: which-key-ellipsis
   value: nil
    type: (string)
...
   FAILED  1/1  check-for-wrong-custom-opts (39.873179 sec) at misc/test-custom-opts.el:33

Ran 1 tests, 0 results as expected, 1 unexpected (2024-06-24 21:14:57+0200, 40.332174 sec)

1 unexpected results:
   FAILED  check-for-wrong-custom-opts
--8<---------------cut here---------------end--------------->8---

Re: master fa4203300fd: Merge remote-tracking branch 'origin/feature/which-key-in-core'

[Philip Kaludercic]

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

Michael Albinus <michael.albinus@gmx.de> writes:

> Philip Kaludercic <philipk@posteo.net> writes:
>
>> branch: master
>> commit fa4203300fde6820a017bf1089652fb95759d68c
>> Merge: a7dff8c53dd cc0a3a5f65b
>> Author: Philip Kaludercic <philipk@posteo.net>
>> Commit: Philip Kaludercic <philipk@posteo.net>
>>
>>     Merge remote-tracking branch 'origin/feature/which-key-in-core'
>> ---
>>  etc/NEWS                     |    7 +
>>  lisp/which-key.el            | 2814 ++++++++++++++++++++++++++++++++++++++++++
>>  test/lisp/which-key-tests.el |  267 ++++
>>  3 files changed, 3088 insertions(+)
>
> Seen in the emacs-30 branch:
>
> # make -C test test-custom-opts
> ...
> The following options might have problems:
> variable: which-key-separator
>    value: nil
>     type: (string)
> variable: which-key-ellipsis
>    value: nil
>     type: (string)
> ...
>    FAILED  1/1  check-for-wrong-custom-opts (39.873179 sec) at misc/test-custom-opts.el:33
>
> Ran 1 tests, 0 results as expected, 1 unexpected (2024-06-24 21:14:57+0200, 40.332174 sec)
>
> 1 unexpected results:
>    FAILED  check-for-wrong-custom-opts

This should fix the issue:


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-lisp-which-key.el-which-key-dont-use-unicode-Add-ini.patch --]
[-- Type: text/x-patch, Size: 1131 bytes --]

From c707ba33a4c3b1de7cb7e8c35736e48ced81a0e0 Mon Sep 17 00:00:00 2001
From: Philip Kaludercic <philipk@posteo.net>
Date: Mon, 24 Jun 2024 22:15:25 +0200
Subject: [PATCH] ; * lisp/which-key.el (which-key-dont-use-unicode): Add
 :initialize

This fixes the change from 768e92b9, which accidentally would call
'custom-reevaluate-setting' on user options before they were registered,
initialising their default value to nil.  When the 'defcustom'
expressions were evaluated later on, they were not properly initialised
as their variables were already bound to some value (nil).

https://lists.gnu.org/archive/html/emacs-devel/2024-06/msg00825.html
---
 lisp/which-key.el | 1 +
 1 file changed, 1 insertion(+)

diff --git a/lisp/which-key.el b/lisp/which-key.el
index 91007ce4ada..8b78bfb2576 100644
--- a/lisp/which-key.el
+++ b/lisp/which-key.el
@@ -133,6 +133,7 @@ which-key-dont-use-unicode
          (mapc #'custom-reevaluate-setting
                '(which-key-separator
                  which-key-ellipsis)))
+  :initialize #'custom-initialize-changed
   :type 'boolean
   :package-version "1.0" :version "30.1")
 
-- 
2.45.2


[-- Attachment #3: Type: text/plain, Size: 37 bytes --]


-- 
	Philip Kaludercic on peregrine

Re: master fa4203300fd: Merge remote-tracking branch 'origin/feature/which-key-in-core'

[Michael Albinus]

Philip Kaludercic <philipk@posteo.net> writes:

Hi Philip,

>> 1 unexpected results:
>>    FAILED  check-for-wrong-custom-opts
>
> This should fix the issue:

Perhaps. Please install; we'll see it then.

Best regards, Michael.

Re: master fa4203300fd: Merge remote-tracking branch 'origin/feature/which-key-in-core'

[Philip Kaludercic]

Michael Albinus <michael.albinus@gmx.de> writes:

> Philip Kaludercic <philipk@posteo.net> writes:
>
> Hi Philip,
>
>>> 1 unexpected results:
>>>    FAILED  check-for-wrong-custom-opts
>>
>> This should fix the issue:
>
> Perhaps. Please install; we'll see it then.

I have already done so, unless Git is deceiving me.

> Best regards, Michael.

-- 
	Philip Kaludercic on peregrine

Re: master fa4203300fd: Merge remote-tracking branch 'origin/feature/which-key-in-core'

[Michael Albinus]

Philip Kaludercic <philipk@posteo.net> writes:

Hi Philip,

>>>> 1 unexpected results:
>>>>    FAILED  check-for-wrong-custom-opts
>>>
>>> This should fix the issue:
>>
>> Perhaps. Please install; we'll see it then.
>
> I have already done so, unless Git is deceiving me.

Thanks. Confirmed, that it fixes the problem.

Best regards, Michael.