bug#4362: 23.1: proced -- Mode help lists 'd' as mark command (prefer 'm')

bug#4362: 23.1: proced -- Mode help lists 'd' as mark command (prefer 'm')

[Jari Aalto]

M-x proced
C-h m


    Proced: user by -PU mode:
    Mode for displaying UNIX system processes and sending signals to them.
    Type M-x proced to start a Proced session.  In a Proced buffer
>>  type d to mark a process for later commands.
    Type x to send signals to marked processes.

SUGGESITON

PLease prefer listing the 'm' as the mark command in the mode help
listing. 'd' and 'm' both seem to mark lines, but for mode help, listing
the 'm' would better follow the convention used in other buffers like buffer
list, dired etc.

bug#4362: marked as done (23.1: proced -- Mode help lists 'd' as mark command (prefer 'm'))

[Emacs bug Tracking System]

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

Your message dated Sun, 06 Sep 2009 22:35:58 -0400
with message-id <l2y6orcwhd.fsf@fencepost.gnu.org>
and subject line Re: bug#4362: 23.1: proced -- Mode help lists 'd' as mark command (prefer 'm')
has caused the Emacs bug report #4362,
regarding 23.1: proced -- Mode help lists 'd' as mark command (prefer 'm')
to be marked as done.

This means that you claim that the problem has been dealt with.
If this is not the case it is now your responsibility to reopen the
bug report if necessary, and/or fix the problem forthwith.

(NB: If you are a system administrator and have no idea what this
message is talking about, this may indicate a serious mail system
misconfiguration somewhere. Please contact owner@emacsbugs.donarmstrong.com
immediately.)


-- 
4362: http://emacsbugs.donarmstrong.com/cgi-bin/bugreport.cgi?bug=4362
Emacs Bug Tracking System
Contact owner@emacsbugs.donarmstrong.com with problems

[-- Attachment #2: Type: message/rfc822, Size: 2721 bytes --]

From: Jari Aalto <jari.aalto@cante.net>
To: Emacs bug BTS <submit@emacsbugs.donarmstrong.com>
Subject: 23.1: proced -- Mode help lists 'd' as mark command (prefer 'm')
Date: Sun, 06 Sep 2009 20:28:11 +0300
Message-ID: <87bplonftg.fsf@jondo.cante.net>


M-x proced
C-h m


    Proced: user by -PU mode:
    Mode for displaying UNIX system processes and sending signals to them.
    Type M-x proced to start a Proced session.  In a Proced buffer
>>  type d to mark a process for later commands.
    Type x to send signals to marked processes.

SUGGESITON

PLease prefer listing the 'm' as the mark command in the mode help
listing. 'd' and 'm' both seem to mark lines, but for mode help, listing
the 'm' would better follow the convention used in other buffers like buffer
list, dired etc.


[-- Attachment #3: Type: message/rfc822, Size: 1679 bytes --]

From: Glenn Morris <rgm@gnu.org>
To: 4362-done@emacsbugs.donarmstrong.com
Subject: Re: bug#4362: 23.1: proced -- Mode help lists 'd' as mark command (prefer 'm')
Date: Sun, 06 Sep 2009 22:35:58 -0400
Message-ID: <l2y6orcwhd.fsf@fencepost.gnu.org>


  * proced.el (proced-mode-map): Bind "d" to proced-mark-alt.
  (proced-mark-alt): New alias, to control the advertised key.  (Bug#4362)

bug#4362: 23.1: proced -- Mode help lists 'd' as mark command (prefer 'm')

[Juri Linkov]

> M-x proced
> C-h m
>     Proced: user by -PU mode:
>     Mode for displaying UNIX system processes and sending signals to them.
>     Type M-x proced to start a Proced session.  In a Proced buffer
>>>  type d to mark a process for later commands.
>     Type x to send signals to marked processes.
>
> SUGGESITON
>
> PLease prefer listing the 'm' as the mark command in the mode help
> listing. 'd' and 'm' both seem to mark lines, but for mode help, listing
> the 'm' would better follow the convention used in other buffers like buffer
> list, dired etc.
>
> From: Glenn Morris <rgm@gnu.org>
> To: 4362-done@emacsbugs.donarmstrong.com
> Date: Sun, 06 Sep 2009 22:35:58 -0400
>
>   * proced.el (proced-mode-map): Bind "d" to proced-mark-alt.
>   (proced-mark-alt): New alias, to control the advertised key.  (Bug#4362)

But now `C-h m' displays:

m		proced-mark
d		proced-mark-alt

that causes a false impression that these commands are different.

A simpler fix would be just changing the order of `d' and `m' bindings
in `proced-mode-map' like:

@@ -459,8 +459,8 @@
     (define-key km [down] 'next-line)
     (define-key km [up] 'previous-line)
     ;; marking
-    (define-key km "d" 'proced-mark) ; Dired compatibility ("delete")
     (define-key km "m" 'proced-mark)
+    (define-key km "d" 'proced-mark) ; Dired compatibility ("delete")
     (define-key km "u" 'proced-unmark)
     (define-key km "\177" 'proced-unmark-backward)
     (define-key km "M" 'proced-mark-all)

But really I don't understand why `m' should be preferred to `d'?
In Proced like in Dired, `d' flags a process for deletion, and `x'
commits the operation.  `m' is an alias for `d' because currently there
is no more dired-like operations on processes.

The only reason to prefer `m' over `d' in the documentation now is
the fact that proced-mark marks a process with the "*" character
(like dired's `m' does) instead of "D" (like dired's "d" does)
until someone comes with an idea of different operations
for `m' and `d' in Proced like in Buffer-menu where they are bound
to different commands:

  m -- mark current line's buffer to be displayed.
  d -- mark that buffer to be deleted, and move down.
  x -- delete or save marked buffers.

-- 
Juri Linkov
http://www.jurta.org/emacs/

bug#4362: 23.1: proced -- Mode help lists 'd' as mark command (prefer 'm')

[Juri Linkov]

> @@ -459,8 +459,8 @@
>      (define-key km [down] 'next-line)
>      (define-key km [up] 'previous-line)
>      ;; marking
> -    (define-key km "d" 'proced-mark) ; Dired compatibility ("delete")
>      (define-key km "m" 'proced-mark)
> +    (define-key km "d" 'proced-mark) ; Dired compatibility ("delete")
>      (define-key km "u" 'proced-unmark)
>      (define-key km "\177" 'proced-unmark-backward)
>      (define-key km "M" 'proced-mark-all)

Hmm, the trick with changing the order of key bindings doesn't work
in `Buffer-menu-mode-map'.  It would be more preferable to mention "d"
instead of "k" as the key to mark that buffer to be deleted in the
*Buffer List*, but changing the order of

    (define-key map "d" 'Buffer-menu-delete)
    (define-key map "k" 'Buffer-menu-delete)

has no effect of the output of `C-h m' in the *Buffer List*.

-- 
Juri Linkov
http://www.jurta.org/emacs/

bug#4362: 23.1: proced -- Mode help lists 'd' as mark command (prefer 'm')

[Glenn Morris]

Juri Linkov wrote:

> But now `C-h m' displays:
>
> m		proced-mark
> d		proced-mark-alt
>
> that causes a false impression that these commands are different.

Perhaps C-h m should merge aliases like where-is seems to do.

> A simpler fix would be just changing the order of `d' and `m' bindings
> in `proced-mode-map' like:

I just copied the undo/advertised-undo approach. Please feel free to
change this as you see fit.

bug#4362: 23.1: proced -- Mode help lists 'd' as mark command (prefer 'm')

[Juri Linkov]

>> But now `C-h m' displays:
>>
>> m		proced-mark
>> d		proced-mark-alt
>>
>> that causes a false impression that these commands are different.
>
> Perhaps C-h m should merge aliases like where-is seems to do.
>
>> A simpler fix would be just changing the order of `d' and `m' bindings
>> in `proced-mode-map' like:
>
> I just copied the undo/advertised-undo approach. Please feel free to
> change this as you see fit.

Using the `:advertised-binding' property just implemented by Stefan is
a nice solution.  But other changes in `where-is-internal' broke preferred
key bindings in docstrings.  For example, compare the old and new
output of `C-h f Info-mode RET':

- h	Invoke the Info tutorial.
+ M-x Info-help	Invoke the Info tutorial.

- u	Move "up" from this node.
+ ^	Move "up" from this node.

- t	Go to the Top node of this file.
+ <	Go to the Top node of this file.

- b	Go to beginning of node.
+ .	Go to beginning of node.

- w	Put name of current Info node in the kill ring.
+ c	Put name of current Info node in the kill ring.

Should we put `:advertised-binding' for all old preferred key bindings
explicitly?

-- 
Juri Linkov
http://www.jurta.org/emacs/

bug#4362: 23.1: proced -- Mode help lists 'd' as mark command (prefer 'm')

[Stefan Monnier]

> Using the `:advertised-binding' property just implemented by Stefan is
> a nice solution.  But other changes in `where-is-internal' broke preferred
> key bindings in docstrings.  For example, compare the old and new
> output of `C-h f Info-mode RET':

> - h	Invoke the Info tutorial.
> + M-x Info-help	Invoke the Info tutorial.

I just fixed this one.  It was a plain bug.

> - u	Move "up" from this node.
> + ^	Move "up" from this node.

> - t	Go to the Top node of this file.
> + <	Go to the Top node of this file.

> - b	Go to beginning of node.
> + .	Go to beginning of node.

> - w	Put name of current Info node in the kill ring.
> + c	Put name of current Info node in the kill ring.

These are trickier.  I still haven't figured out why the preference
order has changed.  Admittedly, this order was arbitrary (doesn't even
depend on the order of calls to define-key since these bindings are
stored in the vector part of a dense map) and is also arbitrary in the
new code, but it would be better to preserve the old order.

> Should we put `:advertised-binding' for all old preferred key bindings
> explicitly?

Arguably, it would be good, yes.  But first, I'll try to adjust the code
to get back the original behavior.  Thanks for bringing it up.


        Stefan