GNU bug report logs - #8947
24.0.50; `describe-mode': `help-mode-map' pollutes minor mode descriptions

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 8947 in the body.
You can then email your comments to 8947 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: "Drew Adams" <drew.adams <at> oracle.com>
To: <bug-gnu-emacs <at> gnu.org>
Subject: 24.0.50;
	`describe-mode': `help-mode-map' pollutes minor mode descriptions
Date: Mon, 27 Jun 2011 15:41:59 -0700

This bug seems to date from the first day that `describe-mode' included
minor-mode information.
 
emacs -Q
 
Visit any *.el file, hit `C-h m', then search for `Transient' in *Help*.
The help for `transient-mark-mode' says this:
 
"...for example, incremental search, <, and >."
 
`<' and `>' here should be `M-<' and `M->'.  The bug happens because
`help-mode-map' is being used to interpret `\\[beginning-of-buffer]'
and `\\[end-of-buffer]'.  In the *Help* buffer, where the text is
used, the current keymap is being picked up, where these commands
are bound to `<' and `>'.
 
Note that the problem isn't manifested for something like `C-h f
transient-mark-mode'.  In that case the bindings picked up are those of
the current buffer where the command is issued.  If you do that in
*Help* then you get `<' and `>'.  If you do it in *.el then you get
`M-<' and `M->'.
 
In GNU Emacs 24.0.50.1 (i386-mingw-nt5.1.2600)
 of 2011-06-27 on 3249CTO
Windowing system distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (4.5) --no-opt --cflags
-Ic:/build/include'
 

Message #8 received at 8947 <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: "Drew Adams" <drew.adams <at> oracle.com>
Cc: 8947 <at> debbugs.gnu.org
Subject: Re: bug#8947: 24.0.50;
 `describe-mode': `help-mode-map' pollutes minor mode descriptions
Date: Sun, 09 Feb 2014 21:07:24 -0800

"Drew Adams" <drew.adams <at> oracle.com> writes:

> Visit any *.el file, hit `C-h m', then search for `Transient' in *Help*.
> The help for `transient-mark-mode' says this:
>
> "...for example, incremental search, <, and >."
>
> `<' and `>' here should be `M-<' and `M->'.  The bug happens because
> `help-mode-map' is being used to interpret `\\[beginning-of-buffer]'
> and `\\[end-of-buffer]'.  In the *Help* buffer, where the text is
> used, the current keymap is being picked up, where these commands
> are bound to `<' and `>'.

This bug still exists in Emacs 24.3.

-- 
(domestic pets only, the antidote for overdose, milk.)
  bloggy blog http://lars.ingebrigtsen.no/

Message #13 received at 8947 <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: "Drew Adams" <drew.adams <at> oracle.com>
Cc: 8947 <at> debbugs.gnu.org
Subject: Re: bug#8947: 24.0.50;
 `describe-mode': `help-mode-map' pollutes minor mode descriptions
Date: Thu, 28 Apr 2016 13:04:19 +0200

Lars Ingebrigtsen <larsi <at> gnus.org> writes:

> "Drew Adams" <drew.adams <at> oracle.com> writes:
>
>> Visit any *.el file, hit `C-h m', then search for `Transient' in *Help*.
>> The help for `transient-mark-mode' says this:
>>
>> "...for example, incremental search, <, and >."
>>
>> `<' and `>' here should be `M-<' and `M->'.  The bug happens because
>> `help-mode-map' is being used to interpret `\\[beginning-of-buffer]'
>> and `\\[end-of-buffer]'.  In the *Help* buffer, where the text is
>> used, the current keymap is being picked up, where these commands
>> are bound to `<' and `>'.
>
> This bug still exists in Emacs 24.3.

Here's a shorter test case:

(progn
  (describe-function 'transient-mark-mode)
  (with-current-buffer (get-buffer "*Help*")
    (revert-buffer)))

After answering "y", the `M-'s will go missing before the `<' and '>'.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

Message #16 received at 8947 <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: "Drew Adams" <drew.adams <at> oracle.com>
Cc: 8947 <at> debbugs.gnu.org
Subject: Re: bug#8947: 24.0.50;
 `describe-mode': `help-mode-map' pollutes minor mode descriptions
Date: Sun, 01 May 2016 20:32:00 +0200

Lars Ingebrigtsen <larsi <at> gnus.org> writes:

> Here's a shorter test case:
>
> (progn
>   (describe-function 'transient-mark-mode)
>   (with-current-buffer (get-buffer "*Help*")
>     (revert-buffer)))
>
> After answering "y", the `M-'s will go missing before the `<' and '>'.

Hm...  well, after fiddling with this a bit more, I see that it's
describing all these minor mode bindings in the context of the buffer
you were in when you called the description command.  I think that's
correct.  If you have these commands bound to `<' etc in that mode, then
that is what the help command will say.

So the form above will give different results when run from, say,
*scratch* and from a special mode, and that's fine.  Closing.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

Message #23 received at 8947 <at> debbugs.gnu.org (full text, mbox):

From: Drew Adams <drew.adams <at> oracle.com>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: 8947 <at> debbugs.gnu.org
Subject: RE: bug#8947: 24.0.50; `describe-mode': `help-mode-map' pollutes
 minor mode descriptions
Date: Sun, 1 May 2016 13:06:13 -0700 (PDT)

> Hm...  well, after fiddling with this a bit more, I see that it's
> describing all these minor mode bindings in the context of the buffer
> you were in when you called the description command.  I think that's
> correct.  If you have these commands bound to `<' etc in that mode, then
> that is what the help command will say.
> 
> So the form above will give different results when run from, say,
> *scratch* and from a special mode, and that's fine.  Closing.

One of us is missing something, I think.

The recipe I gave was this:

  emacs -Q
 
  Visit any *.el file, hit `C-h m', then search for `Transient'
  ^^^^^^^^^^^^^^^^^^^
  in *Help*.  The help for `transient-mark-mode' says this:
 
  "...for example, incremental search, <, and >."

And I explained the cause: The doc for `transient-mark-mode'
is being picked up after *Help* has become the current buffer.
That is not the correct behavior.

It is NOT being picked up from "the context of the buffer
you were in when you called the description command".  That's
exactly what the bug is: it is NOT behaving as you claim it
is.  It is showing you `transient-mark-mode' bindings for
`Help' mode, not for `Emacs-Lisp' mode, which was the mode
of the buffer where you hit `C-h m'.

This should not have been closed, or else I am truly missing
something.

Message #26 received at 8947 <at> debbugs.gnu.org (full text, mbox):

From: Michael Heerdegen <michael_heerdegen <at> web.de>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: Lars Ingebrigtsen <larsi <at> gnus.org>, 8947 <at> debbugs.gnu.org
Subject: Re: bug#8947: 24.0.50;
 `describe-mode': `help-mode-map' pollutes minor mode descriptions
Date: Sun, 01 May 2016 22:20:22 +0200

Drew Adams <drew.adams <at> oracle.com> writes:

> The recipe I gave was this:
>
>   emacs -Q
>  
>   Visit any *.el file, hit `C-h m', then search for `Transient'
>   ^^^^^^^^^^^^^^^^^^^
>   in *Help*.  The help for `transient-mark-mode' says this:
>  
>   "...for example, incremental search, <, and >."
>
> And I explained the cause: The doc for `transient-mark-mode'
> is being picked up after *Help* has become the current buffer.
> That is not the correct behavior.

I agree.  I can reproduce this, and your explanation makes sense.


Michael.

Message #29 received at 8947 <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 8947 <at> debbugs.gnu.org
Subject: Re: bug#8947: 24.0.50;
 `describe-mode': `help-mode-map' pollutes minor mode descriptions
Date: Sun, 01 May 2016 22:23:23 +0200

Drew Adams <drew.adams <at> oracle.com> writes:

> One of us is missing something, I think.
>
> The recipe I gave was this:
>
>   emacs -Q
>
>   Visit any *.el file, hit `C-h m', then search for `Transient'
>   ^^^^^^^^^^^^^^^^^^^
>   in *Help*.  The help for `transient-mark-mode' says this:
>
>   "...for example, incremental search, <, and >."

Hm, so it does.  Reopening.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

Message #36 received at 8947 <at> debbugs.gnu.org (full text, mbox):

From: Drew Adams <drew.adams <at> oracle.com>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: 8947 <at> debbugs.gnu.org
Subject: RE: bug#8947: 24.0.50; `describe-mode': `help-mode-map' pollutes
 minor mode descriptions
Date: Fri, 21 Oct 2016 07:30:06 -0700 (PDT)

This bug was summarily closed today as "wontfix".  Why?
No explanation; just closed out of the blue.  Perhaps
the close was a typo on the bug number?

Please read the (short, simple) thread.  Two Emacs developers
have confirmed that this is a bug, one of them after thinking
at first that it might not be (it was closed and then reopened).

Please reopen (and fix) this bug.  Thx.

Message #39 received at 8947 <at> debbugs.gnu.org (full text, mbox):

From: Noam Postavsky <npostavs <at> users.sourceforge.net>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: Lars Ingebrigtsen <larsi <at> gnus.org>, 8947 <at> debbugs.gnu.org
Subject: Re: bug#8947: 24.0.50; `describe-mode': `help-mode-map' pollutes
 minor mode descriptions
Date: Fri, 21 Oct 2016 10:51:18 -0400

On Fri, Oct 21, 2016 at 10:30 AM, Drew Adams <drew.adams <at> oracle.com> wrote:
> This bug was summarily closed today as "wontfix".

No, it was closed as wontfix on May 1st, 2016, then reopened after
some discussion.

https://debbugs.gnu.org/cgi/bugreport.cgi?msg=18;bug=8947
https://debbugs.gnu.org/cgi/bugreport.cgi?bug=8947#29

I just removed the wontfix tag last night (since Lars obviously forgot
to remove it when reopening)

https://debbugs.gnu.org/cgi/bugreport.cgi?msg=33;bug=8947

Message #42 received at 8947 <at> debbugs.gnu.org (full text, mbox):

From: Drew Adams <drew.adams <at> oracle.com>
To: Noam Postavsky <npostavs <at> users.sourceforge.net>
Cc: Lars Ingebrigtsen <larsi <at> gnus.org>, 8947 <at> debbugs.gnu.org
Subject: RE: bug#8947: 24.0.50; `describe-mode': `help-mode-map' pollutes
 minor mode descriptions
Date: Fri, 21 Oct 2016 08:42:05 -0700 (PDT)

> > This bug was summarily closed today as "wontfix".
> 
> No, it was closed as wontfix on May 1st, 2016, then reopened after
> some discussion.
> 
> https://debbugs.gnu.org/cgi/bugreport.cgi?msg=18;bug=8947
> https://debbugs.gnu.org/cgi/bugreport.cgi?bug=8947#29
> 
> I just removed the wontfix tag last night (since Lars obviously forgot
> to remove it when reopening)
> 
> https://debbugs.gnu.org/cgi/bugreport.cgi?msg=33;bug=8947

OK, thanks for doing that.
Sorry for misunderstanding the control message.

Message #45 received at 8947 <at> debbugs.gnu.org (full text, mbox):

From: Stefan Kangas <stefan <at> marxist.se>
To: Michael Heerdegen <michael_heerdegen <at> web.de>
Cc: Lars Ingebrigtsen <larsi <at> gnus.org>, 8947 <at> debbugs.gnu.org,
 Drew Adams <drew.adams <at> oracle.com>
Subject: Re: bug#8947: 24.0.50; `describe-mode': `help-mode-map' pollutes
 minor mode descriptions
Date: Thu, 21 Oct 2021 12:44:23 -0700

Michael Heerdegen <michael_heerdegen <at> web.de> writes:

> Drew Adams <drew.adams <at> oracle.com> writes:
>
>> The recipe I gave was this:
>>
>>   emacs -Q
>>
>>   Visit any *.el file, hit `C-h m', then search for `Transient'
>>   ^^^^^^^^^^^^^^^^^^^
>>   in *Help*.  The help for `transient-mark-mode' says this:
>>
>>   "...for example, incremental search, <, and >."
>>
>> And I explained the cause: The doc for `transient-mark-mode'
>> is being picked up after *Help* has become the current buffer.
>> That is not the correct behavior.
>
> I agree.  I can reproduce this, and your explanation makes sense.

I can no longer reproduce this using the above recipe; the
`transient-mode-mark' docstring was changed in commit b99192fe24fc.

Do we have an up-to-date reproducer for this?

Message #48 received at 8947 <at> debbugs.gnu.org (full text, mbox):

From: Drew Adams <drew.adams <at> oracle.com>
To: Stefan Kangas <stefan <at> marxist.se>, Michael Heerdegen
 <michael_heerdegen <at> web.de>
Cc: Lars Ingebrigtsen <larsi <at> gnus.org>,
 "8947 <at> debbugs.gnu.org" <8947 <at> debbugs.gnu.org>
Subject: RE: [External] : Re: bug#8947: 24.0.50; `describe-mode':
 `help-mode-map' pollutes minor mode descriptions
Date: Thu, 21 Oct 2021 20:59:55 +0000

> I can no longer reproduce this using the above recipe; the
> `transient-mode-mark' docstring was changed in commit b99192fe24fc.
> 
> Do we have an up-to-date reproducer for this?

Not from me.  I don't see the problem in Emacs 27.2.

Message #51 received at 8947 <at> debbugs.gnu.org (full text, mbox):

From: Stefan Kangas <stefan <at> marxist.se>
To: Drew Adams <drew.adams <at> oracle.com>,
 Michael Heerdegen <michael_heerdegen <at> web.de>
Cc: Lars Ingebrigtsen <larsi <at> gnus.org>,
 "8947 <at> debbugs.gnu.org" <8947 <at> debbugs.gnu.org>
Subject: RE: [External] : Re: bug#8947: 24.0.50; `describe-mode':
 `help-mode-map' pollutes minor mode descriptions
Date: Thu, 21 Oct 2021 14:19:13 -0700

tags 8947 unreproducible
close 8947
thanks

Drew Adams <drew.adams <at> oracle.com> writes:

>> I can no longer reproduce this using the above recipe; the
>> `transient-mode-mark' docstring was changed in commit b99192fe24fc.
>>
>> Do we have an up-to-date reproducer for this?
>
> Not from me.  I don't see the problem in Emacs 27.2.

OK, I'm therefore closing this bug report as unreproducible.  If anyone
knows how to reproduce it, please write back and we can reopen the bug
report.

Message #58 received at 8947 <at> debbugs.gnu.org (full text, mbox):

From: Drew Adams <drew.adams <at> oracle.com>
To: Stefan Kangas <stefan <at> marxist.se>, Michael Heerdegen
 <michael_heerdegen <at> web.de>
Cc: Lars Ingebrigtsen <larsi <at> gnus.org>,
 "8947 <at> debbugs.gnu.org" <8947 <at> debbugs.gnu.org>
Subject: RE: [External] : Re: bug#8947: 24.0.50; `describe-mode':
 `help-mode-map' pollutes minor mode descriptions
Date: Thu, 21 Oct 2021 21:48:39 +0000

> tags 8947 unreproducible
> close 8947
> thanks
> 
> Drew Adams <drew.adams <at> oracle.com> writes:
> 
> >> I can no longer reproduce this using the above recipe; the
> >> `transient-mode-mark' docstring was changed in commit b99192fe24fc.
> >>
> >> Do we have an up-to-date reproducer for this?
> >
> > Not from me.  I don't see the problem in Emacs 27.2.
> 
> OK, I'm therefore closing this bug report as unreproducible.  If anyone
> knows how to reproduce it, please write back and we can reopen the bug
> report.

Does unreproducible mean that it never could be reproduced, or that it can no longer be reproduced?

If it was reproducible (which this was), and it no longer manifests, then it was _fixed_ (even if by accident), no?

Message #61 received at 8947 <at> debbugs.gnu.org (full text, mbox):

From: Stefan Kangas <stefan <at> marxist.se>
To: Drew Adams <drew.adams <at> oracle.com>,
 Michael Heerdegen <michael_heerdegen <at> web.de>
Cc: Lars Ingebrigtsen <larsi <at> gnus.org>,
 "8947 <at> debbugs.gnu.org" <8947 <at> debbugs.gnu.org>
Subject: RE: [External] : Re: bug#8947: 24.0.50; `describe-mode':
 `help-mode-map' pollutes minor mode descriptions
Date: Thu, 21 Oct 2021 15:21:14 -0700

Drew Adams <drew.adams <at> oracle.com> writes:

> Does unreproducible mean that it never could be reproduced, or that it
> can no longer be reproduced?

AFAIU, it was reproducible, but it is no longer.

I guess fixed might be better, so feel free to change its status.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.