bug#44384: 27.1; Bug in finder-commentary buffer

bug#44384: 27.1; Bug in finder-commentary buffer

[Robert Thorpe]

The quit feature in the finder-commentary buffer doesn't work.  I use
finder-commentary on a library, e.g. M-x finder-commentary appt.  Then I
switch to the buffer it creates.  Now, 'C-h m' tells me that I can press
"q" to quit it and all other finder buffers.  This doesn't work.  It
seems to be because the code is expecting the buffer name to be
different.


In GNU Emacs 27.1 (build 1, x86_64-pc-linux-gnu, GTK+ Version 3.24.22, cairo version 1.17.3)
 of 2020-08-28 built on juergen
Windowing system distributor 'The X.Org Foundation', version 11.0.12009000
System Description: Arch Linux

Recent messages:
Sending...
Sending via mail...
Sending email  
Sending email done
Appended to /home/rt/mail/Sent.mbox
Sending...done
uncompressing appt.el.gz...done
RET = select, <mouse-2> = select, d = to finder directory, q = quit, ? = help
You can run the command ‘finder-commentary’ with M-x fin-c RET
RET = select, <mouse-2> = select, d = to finder directory, q = quit, ? = help
Quit
Configured using:
 'configure --prefix=/usr --sysconfdir=/etc --libexecdir=/usr/lib
 --localstatedir=/var --with-x-toolkit=gtk3 --with-xft --with-wide-int
 --with-modules --with-cairo --with-harfbuzz 'CFLAGS=-march=x86-64
 -mtune=generic -O2 -pipe -fno-plt' CPPFLAGS=-D_FORTIFY_SOURCE=2
 LDFLAGS=-Wl,-O1,--sort-common,--as-needed,-z,relro,-z,now'

Configured features:
XPM JPEG TIFF GIF PNG RSVG CAIRO SOUND GPM DBUS GSETTINGS GLIB NOTIFY
INOTIFY ACL GNUTLS LIBXML2 FREETYPE HARFBUZZ M17N_FLT LIBOTF ZLIB
TOOLKIT_SCROLL_BARS GTK3 X11 XDBE XIM MODULES THREADS LIBSYSTEMD JSON
PDUMPER LCMS2 GMP

Important settings:
  value of $LANG: en_GB.UTF-8
  locale-coding-system: utf-8-unix

Major mode: Finder

Minor modes in effect:
  shell-dirtrack-mode: t
  dynamic-completion-mode: t
  tooltip-mode: t
  global-eldoc-mode: t
  electric-indent-mode: t
  mouse-wheel-mode: t
  menu-bar-mode: t
  file-name-shadow-mode: t
  global-font-lock-mode: t
  font-lock-mode: t
  auto-composition-mode: t
  auto-encryption-mode: t
  auto-compression-mode: t
  buffer-read-only: t
  column-number-mode: t
  line-number-mode: t
  global-visual-line-mode: t
  visual-line-mode: t
  transient-mark-mode: t

Load-path shadows:
None found.

Features:
(shadow emacsbug eieio-opt speedbar sb-image ezimage dframe jka-compr
finder finder-inf find-func lisp-mnt package url-handlers cl-extra shell
pcomplete noutline outline easy-mmode rmailsum msb thingatpt help-fns
radix-tree help-mode term comint ansi-color ehelp ring misearch
multi-isearch view disp-table tetris gamegrid mule-util calc-alg
calc-ext calc-menu calc calc-loaddefs calc-macs nnmail gnus-int
gnus-range mail-source gnus nnheader wid-edit gnutls network-stream nsm
mailalias smtpmail sendmail sort dired-aux autorevert filenotify
mail-extr qp rmailout shr-color color shr url-cookie url-domsuf url-util
url-parse auth-source cl-seq eieio eieio-core cl-macs eieio-loaddefs
json map url-vars svg xml dom browse-url rmailmm message rmc puny
dired-x dired dired-loaddefs format-spec rfc822 mml mml-sec
password-cache epa derived epg epg-config gnus-util time-date subr-x seq
byte-opt gv bytecomp byte-compile cconv mm-decode mm-bodies mm-encode
mailabbrev gmm-utils mailheader mail-parse rfc2231 rmail rmail-loaddefs
rfc2047 rfc2045 ietf-drums mm-util mail-prsvr mail-utils bookmark
easymenu text-property-search pp server completion avoid misc edmacro
kmacro cl-loaddefs cl-lib tooltip eldoc electric uniquify ediff-hook
vc-hooks lisp-float-type mwheel term/x-win x-win term/common-win x-dnd
tool-bar dnd fontset image regexp-opt fringe tabulated-list replace
newcomment text-mode elisp-mode lisp-mode prog-mode register page
tab-bar menu-bar rfn-eshadow isearch timer select scroll-bar mouse
jit-lock font-lock syntax facemenu font-core term/tty-colors frame
minibuffer cl-generic cham georgian utf-8-lang misc-lang vietnamese
tibetan thai tai-viet lao korean japanese eucjp-ms cp51932 hebrew greek
romanian slovak czech european ethiopic indian cyrillic chinese
composite charscript charprop case-table epa-hook jka-cmpr-hook help
simple abbrev obarray cl-preloaded nadvice loaddefs button faces
cus-face macroexp files text-properties overlay sha1 md5 base64 format
env code-pages mule custom widget hashtable-print-readable backquote
threads dbusbind inotify lcms2 dynamic-setting system-font-setting
font-render-setting cairo move-toolbar gtk x-toolkit x multi-tty
make-network-process emacs)

Memory information:
((conses 16 168788 53165)
 (symbols 48 18078 1)
 (strings 32 50391 4231)
 (string-bytes 1 1436705)
 (vectors 16 35898)
 (vector-slots 8 1099753 36016)
 (floats 8 260 362)
 (intervals 56 2756 769)
 (buffers 1000 34))

bug#44384: 27.1; Bug in finder-commentary buffer

[Stephen Berman]

On Mon, 02 Nov 2020 04:13:35 +0000 Robert Thorpe <rt@robertthorpeconsulting.com> wrote:

> The quit feature in the finder-commentary buffer doesn't work.  I use
> finder-commentary on a library, e.g. M-x finder-commentary appt.  Then I
> switch to the buffer it creates.  Now, 'C-h m' tells me that I can press
> "q" to quit it and all other finder buffers.  This doesn't work.  It
> seems to be because the code is expecting the buffer name to be
> different.

This happens in both emacs-27 and master, but not in 26.3.  The
difference is due to this change:

  commit 070dd439096c0f72d8f73823649e3c650f31c890
  Author:     Stefan Kangas <stefankangas@gmail.com>
  AuthorDate: Fri Jul 12 00:43:12 2019 +0200
  Commit:     Eli Zaretskii <eliz@gnu.org>
  CommitDate: Sat Jul 20 12:23:07 2019 +0300

      Make finder-exit use quit-window (Bug#33610)

      * lisp/finder.el (finder-exit): Quit window instead of
      deleting.  This restores previous contents of the window,
      if any, that was usurped by "C-h p" to show the list of
      packages.

Before this change (i.e. in 26.3), if the frame is split into two (or
more) windows, `q' does delete the Finder window (but doesn't kill the
buffer).  But even there, if the Finder buffer is occupying the sole
window of the frame, then `q' does nothing.  This seems to be due to
this change:

  commit 96ae4c8fa704b0385d6f2cf10b69bf289e2fb7ef
  Author:     Chong Yidong <cyd@stupidchicken.com>
  AuthorDate: Sun Aug 29 18:15:09 2010 -0400
  Commit:     Chong Yidong <cyd@stupidchicken.com>
  CommitDate: Sun Aug 29 18:15:09 2010 -0400

      Merge Finder and package-menu functionality.

      * lisp/finder.el: Require `package'.
      [...]
      (finder-exit): We don't use "*Finder-package*" and "*Finder
      Category*" buffers anymore.

Despite this commit message, finder.el still contains this code:

  (defun finder-commentary (file)
    "Display FILE's commentary section.
  FILE should be in a form suitable for passing to `locate-library'."
  [...]
      (pop-to-buffer "*Finder-package*")
  [...])

Steve Berman

bug#44384: 27.1; Bug in finder-commentary buffer

[Stefan Kangas]

reopen 44384
close 44384 27.2
thanks

Stefan Kangas <stefan@marxist.se> writes:

> I have now fixed this on master.  The fix will be in Emacs 28.1.

By popular request, I've cherry-picked the fix to the emacs-27 branch.

bug#44384: 27.1; Bug in finder-commentary buffer

[Eli Zaretskii]

> Date: Fri, 6 Nov 2020 17:26:12 -0800
> Cc: 44384@debbugs.gnu.org, Robert Thorpe <rt@robertthorpeconsulting.com>
> 
> By popular request, I've cherry-picked the fix to the emacs-27 branch.

Thanks, but a better, less error-prone, way of cherry-picking from
master is this:

  git cherry-pick -xe SHA1
  <edit the log message>
  git push

This is better because the -x switch automatically generates a log
message saying it was cherry-picked from a specific commitm and
git-merge.el will not merge such commits, so you don't have to
remember saying "do not merge" in the log message.  (And having
"backport" in the log message also disables merging.)

Perhaps you did exactly that, but in that case, please don't remove
the telltale "cherry-picked from SHA1" part of the log message
inserted by Git.

bug#44384: 27.1; Bug in finder-commentary buffer

[Stefan Kangas]

Eli Zaretskii <eliz@gnu.org> writes:

> Thanks, but a better, less error-prone, way of cherry-picking from
> master is this:
>
>   git cherry-pick -xe SHA1
>   <edit the log message>
>   git push
>
> This is better because the -x switch automatically generates a log
> message saying it was cherry-picked from a specific commitm and
> git-merge.el will not merge such commits, so you don't have to
> remember saying "do not merge" in the log message.  (And having
> "backport" in the log message also disables merging.)

Thank you, I will note that down for next time.