Subject: Re: bug#35504: 26.2; Key `g' should run `package-menu-refresh' in the *Packages* buffer

From: Stefan Kangas <[email-masked]>
Date: Sat, 02 Nov 2019 03:32:31 +0100

Stefan Kangas <[email-masked]> writes:

> Stefan Monnier <[email-masked]> writes:
>>
>> >> Fine by me.  I wonder, tho: why not set revert-buffer-function and then
>> >> redefine `package-menu-refresh` as an obsolete alias for `revert-buffer`?
>> > Sure, I've tried to do that in the attached patch.  WDYT?
>> [...]
>> > +  (setq revert-buffer-function 'package-menu-revert)
>> [...]
>> > +(define-obsolete-function-alias 'package-menu-refresh 'package-menu-revert "27.1")
>>
>> Could we make package-menu-refresh to be an (obsolete) alias of
>> `revert-buffer` instead (and make package-menu-revert an internal
>> non-interactive function)?
>
> Absolutely, thanks for the suggestion.  Fixed in the attached patch
> together with the things Basil pointed out.
>
> Please let me know what you think.

I've attached an updated patch below.  If there are no further
comments, I intend to commit it in a couple of days.

Best regards,
Stefan Kangas

>From 71bda0bd328a901b2dc17e76f032efd0a10fcfec Mon Sep 17 00:00:00 2001
From: Stefan Kangas <[email-masked]>
Date: Fri, 26 Jul 2019 12:49:35 +0200
Subject: [PATCH] Make 'g' refresh package data in package menu

* lisp/emacs-lisp/package.el (package-menu--refresh): Rename from
'package-menu-refresh', make internal and non-interactive.
(package-menu-mode-map, package-menu-mode-menu, package-menu-mode)
(list-packages): Use the above.  (Bug#35504)
(package-menu-refresh): Redefine as obsolete fuction alias for
'revert-buffer'.
* doc/emacs/package.texi (Package Menu): Document it.
* etc/NEWS: Announce it.
---
 doc/emacs/package.texi     |  9 +++++----
 etc/NEWS                   |  8 ++++++++
 lisp/emacs-lisp/package.el | 17 +++++++++++------
 3 files changed, 24 insertions(+), 10 deletions(-)

diff --git a/doc/emacs/package.texi b/doc/emacs/package.texi
index 19efff7445..1c0f853427 100644
--- a/doc/emacs/package.texi
+++ b/doc/emacs/package.texi
@@ -149,12 +149,13 @@ Package Menu
 dependencies; also, delete all packages marked with @kbd{d}
 (@code{package-menu-execute}).  This also removes the marks.
 
+@item g
 @item r
+@kindex g @r{(Package Menu)}
 @kindex r @r{(Package Menu)}
-@findex package-menu-refresh
-Refresh the package list (@code{package-menu-refresh}).  This fetches
-the list of available packages from the package archive again, and
-recomputes the package list.
+Refresh the package list (@code{revert-buffer}).  This fetches the
+list of available packages from the package archive again, and
+redisplays the package list.
 
 @item / k
 @kindex / k @r{(Package Menu)}
diff --git a/etc/NEWS b/etc/NEWS
index e614197125..79410bbec3 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -1131,6 +1131,14 @@ the 'package-menu-clear-filter' function, bound to '/ /' by default.
 ---
 *** The package list can now be sorted by version or description.
 
++++
+*** In Package Menu, 'g' now updates package data from archives.
+Previously, 'g' invoked 'tabulated-list-revert' which did not update
+the cached archive data.  It is now bound to 'revert-buffer', which
+will now update the data.
+
+'package-menu-refresh' is an obsolete alias for 'revert-buffer'.
+
 ** Info
 
 +++
diff --git a/lisp/emacs-lisp/package.el b/lisp/emacs-lisp/package.el
index 8c8e86aead..3363b1bb52 100644
--- a/lisp/emacs-lisp/package.el
+++ b/lisp/emacs-lisp/package.el
@@ -2690,7 +2690,7 @@ package-menu-mode-map
     (define-key map "d" 'package-menu-mark-delete)
     (define-key map "i" 'package-menu-mark-install)
     (define-key map "U" 'package-menu-mark-upgrades)
-    (define-key map "r" 'package-menu-refresh)
+    (define-key map "r" 'revert-buffer)
     (define-key map (kbd "/ k") 'package-menu-filter-by-keyword)
     (define-key map (kbd "/ n") 'package-menu-filter-by-name)
     (define-key map (kbd "/ /") 'package-menu-clear-filter)
@@ -2709,7 +2709,7 @@ package-menu-mode-menu
     ["Describe Package" package-menu-describe-package :help "Display information about this package"]
     ["Help" package-menu-quick-help :help "Show short key binding help for package-menu-mode"]
     "--"
-    ["Refresh Package List" package-menu-refresh
+    ["Refresh Package List" revert-buffer
      :help "Redownload the ELPA archive"
      :active (not package--downloads-in-progress)]
     ["Redisplay buffer" revert-buffer :help "Update the buffer with current list of packages"]
@@ -2764,6 +2764,7 @@ package-menu-mode
   (setq tabulated-list-sort-key (cons "Status" nil))
   (add-hook 'tabulated-list-revert-hook #'package-menu--refresh nil t)
   (tabulated-list-init-header)
+  (setq revert-buffer-function 'package-menu--refresh)
   (setf imenu-prev-index-position-function
         #'package--imenu-prev-index-position-function)
   (setf imenu-extract-index-name-function
@@ -3161,12 +3162,15 @@ package-menu--print-info-simple
 (defvar package-menu--old-archive-contents nil
   "`package-archive-contents' before the latest refresh.")
 
-(defun package-menu-refresh ()
+(defun package-menu--refresh (&optional _arg _noconfirm)
   "In Package Menu, download the Emacs Lisp package archive.
 Fetch the contents of each archive specified in
 `package-archives', and then refresh the package menu.  Signal a
-user-error if there is already a refresh running asynchronously."
-  (interactive)
+user-error if there is already a refresh running asynchronously.
+
+`package-menu-mode' sets `revert-buffer-function' to this
+function.  The args ARG and NOCONFIRM, passed from
+`revert-buffer', are ignored."
   (unless (derived-mode-p 'package-menu-mode)
     (user-error "The current buffer is not a Package Menu"))
   (when (and package-menu-async package--downloads-in-progress)
@@ -3174,6 +3178,7 @@ package-menu-refresh
   (setq package-menu--old-archive-contents package-archive-contents)
   (setq package-menu--new-package-list nil)
   (package-refresh-contents package-menu-async))
+(define-obsolete-function-alias 'package-menu-refresh 'revert-buffer "27.1")
 
 (defun package-menu-hide-package ()
   "Hide a package under point in Package Menu.
@@ -3637,7 +3642,7 @@ list-packages
       (package-menu-mode)
 
       ;; Fetch the remote list of packages.
-      (unless no-fetch (package-menu-refresh))
+      (unless no-fetch (package-menu--refresh))
 
       ;; If we're not async, this would be redundant.
       (when package-menu-async
-- 
2.20.1