bug#2598: 23.0.91; behavior of vc-dir "x" command does not match documentation

bug#2598: 23.0.91; behavior of vc-dir "x" command does not match documentation

[Miles Bader]

Please write in English if possible, because the Emacs maintainers
usually do not have translators to read other languages for them.

Your bug report will be posted to the emacs-pretest-bug@gnu.org mailing list.

Please describe exactly what actions triggered the bug
and the precise symptoms of the bug:


In the info manual, in node `(emacs) VC Directory Commands', it says:

   `x' toggles hiding of up-to-date files.

However, in a vc-dir buffer, `x' is bound to `vc-dir-hide-up-to-date',
and the behavior of the command seems to match the name -- it does not
toggle the state, and a quick look at the implementation suggests that
indeed, it's only able to hide up-to-date entries, not show them.

The most useful fix for this bug would be to make the "x" command able
to toggle (i.e, show up-to-date files, if they are not already shown),
but at the least, the documentation should match the behavior.

Thanks,

-Miles



If Emacs crashed, and you have the Emacs process in the gdb debugger,
please include the output from the following gdb commands:
    `bt full' and `xbacktrace'.
If you would like to further debug the crash, please read the file
/usr/local/share/emacs/23.0.91/etc/DEBUG for instructions.


In GNU Emacs 23.0.91.6 (x86_64-unknown-linux-gnu, GTK+ Version 2.15.5)
 of 2009-03-06 on catnip
Windowing system distributor `The X.Org Foundation', version 11.0.10599902
Important settings:
  value of $LC_ALL: nil
  value of $LC_COLLATE: nil
  value of $LC_CTYPE: nil
  value of $LC_MESSAGES: nil
  value of $LC_MONETARY: nil
  value of $LC_NUMERIC: nil
  value of $LC_TIME: nil
  value of $LANG: ja_JP.UTF-8
  value of $XMODIFIERS: @im=SCIM
  locale-coding-system: utf-8-unix
  default-enable-multibyte-characters: t

Major mode: Message

Minor modes in effect:
  mml-mode: t
  buffer-face-mode: t
  rcirc-track-minor-mode: t
  tooltip-mode: t
  mouse-wheel-mode: t
  file-name-shadow-mode: t
  global-font-lock-mode: t
  font-lock-mode: t
  blink-cursor-mode: t
  global-auto-composition-mode: t
  auto-composition-mode: t
  auto-encryption-mode: t
  auto-compression-mode: t
  line-number-mode: t
  transient-mark-mode: t
  abbrev-mode: t

Recent input:
C-x g <escape> x r c i SPC <return> C-h i m e m a SPC 
<return> C-x C-v <return> C-v C-s e m a c s <escape> 
< C-x C-v $ l s e / m a s t e r / a d m SPC q SPC <return> 
C-s i n f o C-s C-s C-s C-s C-s C-a C-v C-p C-v C-p 
C-x C-v C-g C-h i <escape> x p w d <return> C-x C-v 
<escape> h <return> ^ C-u C-p C-u C-p C-u C-p C-u C-p 
C-u C-p C-u C-p C-u C-p C-p <return> ^ D y e s <return> 
y e s <return> C-a C-x C-v M-p M-p <return> C-a C-s 
s h a r e d C-s C-s C-s C-s C-s C-a C-s / s h a r e 
C-a C-s / u s r C-a C-r d s t _ i n f o C-r C-r C-e 
M-b s h a r e / C-x C-s C-h i m e m a SPC C-g d <escape> 
x p w d <return> m e m a SPC <return> m v e r SPC <return> 
m s e c o n SPC <return> u n p m v c SPC d i SPC <return> 
SPC SPC SPC C-n C-n C-n C-n C-n C-n C-n C-n C-n C-n 
C-n C-n C-n C-n C-SPC C-n <escape> w <escape> x v c 
- d i r <return> $ s n o g <return> x x x C-h k x C-x 
s C-g <escape> x r e p o r t - e m SPC <return>

Recent messages:
Saving file /usr/local/src/emacs/master/admin/quick-install-emacs...
Wrote /usr/local/src/emacs/master/admin/quick-install-emacs
xding
Quit
Composing main Info directory...done
Directory /usr/local/share/info/
Mark set
Type C-x 4 C-o RET to restore the other window.
Parsing /home/miles/.mailrc... done
xding
Quit
-- 
Vote, v. The instrument and symbol of a freeman's power to make a fool of
himself and a wreck of his country.

bug#2598: marked as done (23.0.91; behavior of vc-dir "x" command does not match documentation)

[Emacs bug Tracking System]

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


Your message dated Sun, 8 Mar 2009 11:42:13 -0700 (PDT)
with message-id <200903081842.n28IgDqr014308@rodan.ics.uci.edu>
and subject line Re: bug#2598: 23.0.91; behavior of vc-dir "x" command does not match documentation
has caused the Emacs bug report #2598,
regarding 23.0.91; behavior of vc-dir "x" command does not match documentation
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.)


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

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

From: Miles Bader <miles@gnu.org>
To: emacs-pretest-bug@gnu.org
Subject: 23.0.91; behavior of vc-dir "x" command does not match documentation
Date: Sun, 08 Mar 2009 14:55:12 +0900
Message-ID: <87ab7w4kzj.fsf@catnip.gol.com>


Please write in English if possible, because the Emacs maintainers
usually do not have translators to read other languages for them.

Your bug report will be posted to the emacs-pretest-bug@gnu.org mailing list.

Please describe exactly what actions triggered the bug
and the precise symptoms of the bug:


In the info manual, in node `(emacs) VC Directory Commands', it says:

   `x' toggles hiding of up-to-date files.

However, in a vc-dir buffer, `x' is bound to `vc-dir-hide-up-to-date',
and the behavior of the command seems to match the name -- it does not
toggle the state, and a quick look at the implementation suggests that
indeed, it's only able to hide up-to-date entries, not show them.

The most useful fix for this bug would be to make the "x" command able
to toggle (i.e, show up-to-date files, if they are not already shown),
but at the least, the documentation should match the behavior.

Thanks,

-Miles



If Emacs crashed, and you have the Emacs process in the gdb debugger,
please include the output from the following gdb commands:
    `bt full' and `xbacktrace'.
If you would like to further debug the crash, please read the file
/usr/local/share/emacs/23.0.91/etc/DEBUG for instructions.


In GNU Emacs 23.0.91.6 (x86_64-unknown-linux-gnu, GTK+ Version 2.15.5)
 of 2009-03-06 on catnip
Windowing system distributor `The X.Org Foundation', version 11.0.10599902
Important settings:
  value of $LC_ALL: nil
  value of $LC_COLLATE: nil
  value of $LC_CTYPE: nil
  value of $LC_MESSAGES: nil
  value of $LC_MONETARY: nil
  value of $LC_NUMERIC: nil
  value of $LC_TIME: nil
  value of $LANG: ja_JP.UTF-8
  value of $XMODIFIERS: @im=SCIM
  locale-coding-system: utf-8-unix
  default-enable-multibyte-characters: t

Major mode: Message

Minor modes in effect:
  mml-mode: t
  buffer-face-mode: t
  rcirc-track-minor-mode: t
  tooltip-mode: t
  mouse-wheel-mode: t
  file-name-shadow-mode: t
  global-font-lock-mode: t
  font-lock-mode: t
  blink-cursor-mode: t
  global-auto-composition-mode: t
  auto-composition-mode: t
  auto-encryption-mode: t
  auto-compression-mode: t
  line-number-mode: t
  transient-mark-mode: t
  abbrev-mode: t

Recent input:
C-x g <escape> x r c i SPC <return> C-h i m e m a SPC 
<return> C-x C-v <return> C-v C-s e m a c s <escape> 
< C-x C-v $ l s e / m a s t e r / a d m SPC q SPC <return> 
C-s i n f o C-s C-s C-s C-s C-s C-a C-v C-p C-v C-p 
C-x C-v C-g C-h i <escape> x p w d <return> C-x C-v 
<escape> h <return> ^ C-u C-p C-u C-p C-u C-p C-u C-p 
C-u C-p C-u C-p C-u C-p C-p <return> ^ D y e s <return> 
y e s <return> C-a C-x C-v M-p M-p <return> C-a C-s 
s h a r e d C-s C-s C-s C-s C-s C-a C-s / s h a r e 
C-a C-s / u s r C-a C-r d s t _ i n f o C-r C-r C-e 
M-b s h a r e / C-x C-s C-h i m e m a SPC C-g d <escape> 
x p w d <return> m e m a SPC <return> m v e r SPC <return> 
m s e c o n SPC <return> u n p m v c SPC d i SPC <return> 
SPC SPC SPC C-n C-n C-n C-n C-n C-n C-n C-n C-n C-n 
C-n C-n C-n C-n C-SPC C-n <escape> w <escape> x v c 
- d i r <return> $ s n o g <return> x x x C-h k x C-x 
s C-g <escape> x r e p o r t - e m SPC <return>

Recent messages:
Saving file /usr/local/src/emacs/master/admin/quick-install-emacs...
Wrote /usr/local/src/emacs/master/admin/quick-install-emacs
xding
Quit
Composing main Info directory...done
Directory /usr/local/share/info/
Mark set
Type C-x 4 C-o RET to restore the other window.
Parsing /home/miles/.mailrc... done
xding
Quit
-- 
Vote, v. The instrument and symbol of a freeman's power to make a fool of
himself and a wreck of his country.



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

From: Dan Nicolaescu <dann@ics.uci.edu>
To: Miles Bader <miles@gnu.org>
Cc: 2598-done@emacsbugs.donarmstrong.com
Subject: Re: bug#2598: 23.0.91; behavior of vc-dir "x" command does not match documentation
Date: Sun, 8 Mar 2009 11:42:13 -0700 (PDT)
Message-ID: <200903081842.n28IgDqr014308@rodan.ics.uci.edu>

Miles Bader <miles@gnu.org> writes:

  > Please write in English if possible, because the Emacs maintainers
  > usually do not have translators to read other languages for them.
  > 
  > Your bug report will be posted to the emacs-pretest-bug@gnu.org mailing list.
  > 
  > Please describe exactly what actions triggered the bug
  > and the precise symptoms of the bug:
  > 
  > 
  > In the info manual, in node `(emacs) VC Directory Commands', it says:
  > 
  >    `x' toggles hiding of up-to-date files.
  > 
  > However, in a vc-dir buffer, `x' is bound to `vc-dir-hide-up-to-date',
  > and the behavior of the command seems to match the name -- it does not
  > toggle the state, and a quick look at the implementation suggests that
  > indeed, it's only able to hide up-to-date entries, not show them.

Thanks, I fixed the doc. vc-dir-hide-up-to-date was never intended to toggle.

  > The most useful fix for this bug would be to make the "x" command able
  > to toggle (i.e, show up-to-date files, if they are not already shown),
  > but at the least, the documentation should match the behavior.

To do that correctly querying the VC system would be necessary, and
given that the number of up to date files is usually much bigger than
the modified ones (which is what vc-dir asks for most of the time), it
would be very slow.