bug#28637: [PATCH] Display commit in package description, if available

[David Glasser]

On Tue, Oct 10, 2017 at 3:40 PM, Noam Postavsky
<npostavs@users.sourceforge.net> wrote:
> David Glasser <glasser@davidglasser.net> writes:
>
>> MELPA includes a :commit field in its
>> packages (https://github.com/melpa/package-build/pull/6). You can use
>> this to tell if MELPA has processed a recently-merged change.  This
>> commit adds that metadata to the package description buffer.
>
> Code looks fine, but could you post a "before and after" picture please?
> I'm wondering if it might make sense to abbreviate the hash.

Sure! Here's a randomly chosen melpa package's *Help* page:

```
archive-rpm is a new package.

     Status: New from melpa -- Install
    Archive: melpa
    Version: 20171005.1548
     Commit: 830158cfb3b43c85cfcb4bd5b92d4457d015c80a
    Summary: RPM and CPIO support for archive-mode
   Requires: emacs-24.4

This module adds support for RPM archives to archive-mode.

RPM files consist of metadata plus a compressed CPIO archive, so
this module relies on `archive-cpio'.
```

This is the "after" picture; the "before" picture lacks the Commit line.

Abbreviating the hash might be nice, but it seems like maybe that should be
the job of the code that creates the metadata (ie in melpa's package builder)
rather than the code that displays it.


>> * lisp/emacs-lisp/package.el: Display commit in package description
>
> I think you should have a period at the end of sentence though.

OK, a new version of the patch is below (is this the right way to send
a new version of the patch? I am not used to mail-based git
workflows):

>From a4ebfa2ed35a620e4754399da8181caba13a1eb9 Mon Sep 17 00:00:00 2001
From: David Glasser <glasser@davidglasser.net>
Date: Thu, 28 Sep 2017 14:00:04 -0700
Subject: [PATCH] Display commit in package description, if available

MELPA includes a :commit field in its
packages (https://github.com/melpa/package-build/pull/6). You can use
this to tell if MELPA has processed a recently-merged change.  This
commit adds that metadata to the package description buffer.

* lisp/emacs-lisp/package.el: Display commit in package description.
---
 lisp/emacs-lisp/package.el | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/lisp/emacs-lisp/package.el b/lisp/emacs-lisp/package.el
index 8b101c1323..dd05c70dc8 100644
--- a/lisp/emacs-lisp/package.el
+++ b/lisp/emacs-lisp/package.el
@@ -2260,6 +2260,7 @@ Otherwise no newline is inserted."
          (archive (if desc (package-desc-archive desc)))
          (extras (and desc (package-desc-extras desc)))
          (homepage (cdr (assoc :url extras)))
+         (commit (cdr (assoc :commit extras)))
          (keywords (if desc (package-desc--keywords desc)))
          (built-in (eq pkg-dir 'builtin))
          (installable (and archive (not built-in)))
@@ -2332,6 +2333,8 @@ Otherwise no newline is inserted."
     (and version
          (package--print-help-section "Version"
            (package-version-join version)))
+    (when commit
+      (package--print-help-section "Commit" commit))
     (when desc
       (package--print-help-section "Summary"
         (package-desc-summary desc)))