GNU bug report logs - #34080
27.0.50, 26.1; undocumented key bindings for *vc-diff*

Previous Next

Package: emacs;

Reported by: Van L <van <at> scratch.space>

Date: Tue, 15 Jan 2019 05:31:01 UTC

Severity: wishlist

Found in version 27.0.50

Done: Sean Whitton <spwhitton <at> spwhitton.name>

Full log


View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: Sean Whitton <spwhitton <at> spwhitton.name>
Cc: tracker <at> debbugs.gnu.org
Subject: bug#34080: closed (27.0.50, 26.1; undocumented key bindings for
 *vc-diff*)
Date: Sat, 19 Jul 2025 10:20:02 +0000
[Message part 1 (text/plain, inline)]
Your message dated Sat, 19 Jul 2025 11:18:53 +0100
with message-id <87ldokxz3m.fsf <at> zephyr.silentflame.com>
and subject line Re: bug#34080: 27.0.50, 26.1; undocumented key bindings for *vc-diff*
has caused the debbugs.gnu.org bug report #34080,
regarding 27.0.50, 26.1; undocumented key bindings for *vc-diff*
to be marked as done.

(If you believe you have received this mail in error, please contact
help-debbugs <at> gnu.org.)


-- 
34080: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=34080
GNU Bug Tracking System
Contact help-debbugs <at> gnu.org with problems
[Message part 2 (message/rfc822, inline)]
From: Van L <van <at> scratch.space>
To: bug-gnu-emacs <at> gnu.org
Subject: 27.0.50, 26.1; undocumented key bindings for *vc-diff*
Date: Tue, 15 Jan 2019 16:29:56 +1100
Hello,

The *Help* buffer for diff-mode.el is better 
if the following key bindings are documented 

#+NAME: undocumented-key-bindings
| key   | binding        |
|-------+----------------|
| TAB   | diff-hunk-next |
| S-TAB | diff-hunk-prev |

the above make more sense than the following

#+NAME: existing-key-bindings-documented
| key   | binding        |
|-------+----------------|
| C-M-i | diff-hunk-next |
| M-n   |                |
|-------+----------------|
| M-p   | diff-hunk-prev |

And, for the word "hunk" to link to a Glossary's 
entry like for example

http://www-history.mcs.st-and.ac.uk/Glossary/oblong_number.html

is a feature to have unless it is already therein.


[Message part 3 (message/rfc822, inline)]
From: Sean Whitton <spwhitton <at> spwhitton.name>
To: Stefan Monnier <monnier <at> iro.umontreal.ca>, 34080-done <at> debbugs.gnu.org
Subject: Re: bug#34080: 27.0.50, 26.1; undocumented key bindings for *vc-diff*
Date: Sat, 19 Jul 2025 11:18:53 +0100
Hello,

On Sat 19 Jul 2025 at 09:57am +01, Sean Whitton wrote:

> Hello,
>
> On Fri 18 Jul 2025 at 09:24am -04, Stefan Monnier wrote:
>
>>> I spent some time seeing how this change would be implemented and I now
>>> think that, instead, diff-minor-mode should be renamed
>>> diff-read-only-mode.  Am I right that diff-minor-mode is only intended
>>> as a way to add bindings when diff-mode buffers are read-only?
>>
>> No, `diff-minor-mode` is intended for use in buffers that need to use
>> another major mode than `diff-mode`.
>> [ Like the difference between `outline-mode` and `outline-minor-mode`.  ]
>>
>> Not sure how important it is in practice: IIRC, I implemented this
>> because it existed in other people's "diff modes" (when I started
>> diff-mode I tried to make it a superset of all the diff/patch modes
>> I could find), rather than because I saw a need for it.
>
> Okay, thanks.
>
> Renaming it wouldn't prevent it being used in this way and would improve
> comprehensibility for 90% of users, so I'll go ahead with that.
>
> I'll also experimentally mark diff-minor-mode-prefix as obsolete.

No, that's not right, diff-minor-mode isn't used at all in read-only
diff-mode buffers.  The short bindings are activated in those in another
way.

As can be seen by my messages to this bug, all this has really confused
me, and I think it would confuse the next person, too.  I've tried to
add a clarificatory comment.  Also, I've fixed the original reported
issue, so I'm closing the bug with this message.

If the bug I thought I'd found in where-is-internal is real, it'll come
up again in a context where fixing it is more important.

-- 
Sean Whitton


This bug report was last modified 21 days ago.

Previous Next


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