[PATCH] upstream: Add 'description' field to 'upstream-updater'.

[Alex Kost <alezost@gmail.com>]

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

Ludovic Courtès (2015-10-26 00:46 +0300) wrote:

> Alex Kost <alezost@gmail.com> skribis:
>
>> From 6d82f6384902e7de837a4dbfc86c524dbfd9145a Mon Sep 17 00:00:00 2001
>> From: Alex Kost <alezost@gmail.com>
>> Date: Thu, 22 Oct 2015 10:51:17 +0300
>> Subject: [PATCH] refresh: Add '--list-updaters' option.
>>
>> * guix/scripts/refresh.scm (list-updaters-and-exit): New procedure.
>>   (%options, show-help): Add '--list-updaters' option.
>> * doc/guix.texi (Invoking guix refresh): Document it.
>
> [...]
>
>> +@item --list-updaters
>> +@itemx -L
>> +List available updaters and exit.
>
> Maybe add: “(see @option{--type} below.)”

As I put it right after ‘--type’ option, I'll use “above”, not “below”.

> OK to push with this change!

Thanks!  I think I better modify it so that ‘guix lint --list-checkers’
will also display descriptions, and I push it after (with) the attached
patch.

> To make it even more useful, I wonder if we should add a ‘description’
> field to updaters.

I like it!

> The best way to do that would probably be by definition
> <upstream-updater> with ‘define-record-type*’ (because ‘description’ is
> a known keyword for xgettext, as per po/guix/Makevars.)
>
> WDYT?

Great, thanks for the pointers!  The patch is attached (I hope I missed
nothing there).


[-- Attachment #2: 0001-upstream-Add-description-field-to-upstream-updater.patch --]
[-- Type: text/x-patch, Size: 4265 bytes --]

From 19cee5ca983f663117d272382d7063d48e273cd0 Mon Sep 17 00:00:00 2001
From: Alex Kost <alezost@gmail.com>
Date: Mon, 26 Oct 2015 21:24:53 +0300
Subject: [PATCH] upstream: Add 'description' field to 'upstream-updater'.
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Suggested by Ludovic Courtès <ludo@gnu.org>.

* guix/upstream.scm (<upstream-updater>): Use 'define-record-type*'.
  [description]: New field.
  (lookup-updater): Adjust accordingly.
* guix/gnu-maintenance.scm (%gnu-updater): Likewise.
* guix/import/cran.scm (%cran-updater): Likewise.
* guix/import/elpa.scm (%elpa-updater): Likewise.
---
 guix/gnu-maintenance.scm |  8 +++++---
 guix/import/cran.scm     |  8 +++++---
 guix/import/elpa.scm     |  8 +++++---
 guix/upstream.scm        | 15 +++++++++------
 4 files changed, 24 insertions(+), 15 deletions(-)

diff --git a/guix/gnu-maintenance.scm b/guix/gnu-maintenance.scm
index 5af1b88..e1455cc 100644
--- a/guix/gnu-maintenance.scm
+++ b/guix/gnu-maintenance.scm
@@ -413,8 +413,10 @@ for instance, whose releases are now uploaded to elpa.gnu.org."
        (gnu-package? package)))
 
 (define %gnu-updater
-  (upstream-updater 'gnu
-                    non-emacs-gnu-package?
-                    latest-release*))
+  (upstream-updater
+   (name 'gnu)
+   (description "Updater for GNU packages")
+   (pred non-emacs-gnu-package?)
+   (latest latest-release*)))
 
 ;;; gnu-maintenance.scm ends here
diff --git a/guix/import/cran.scm b/guix/import/cran.scm
index 6284c9e..4b53d5e 100644
--- a/guix/import/cran.scm
+++ b/guix/import/cran.scm
@@ -236,8 +236,10 @@ representation of the package page."
   (string-prefix? "r-" (package-name package)))
 
 (define %cran-updater
-  (upstream-updater 'cran
-                    cran-package?
-                    latest-release))
+  (upstream-updater
+   (name 'cran)
+   (description "Updater for CRAN packages")
+   (pred cran-package?)
+   (latest latest-release)))
 
 ;;; cran.scm ends here
diff --git a/guix/import/elpa.scm b/guix/import/elpa.scm
index 37fc2b8..8c10668 100644
--- a/guix/import/elpa.scm
+++ b/guix/import/elpa.scm
@@ -272,8 +272,10 @@ as \"debbugs\"."
 (define %elpa-updater
   ;; The ELPA updater.  We restrict it to packages hosted on elpa.gnu.org
   ;; because for other repositories, we typically grab the source elsewhere.
-  (upstream-updater 'elpa
-                    package-from-gnu.org?
-                    latest-release))
+  (upstream-updater
+   (name 'elpa)
+   (description "Updater for ELPA packages")
+   (pred package-from-gnu.org?)
+   (latest latest-release)))
 
 ;;; elpa.scm ends here
diff --git a/guix/upstream.scm b/guix/upstream.scm
index 9300113..219ae05 100644
--- a/guix/upstream.scm
+++ b/guix/upstream.scm
@@ -1,5 +1,6 @@
 ;;; GNU Guix --- Functional package management for GNU
 ;;; Copyright © 2010, 2011, 2012, 2013, 2014, 2015 Ludovic Courtès <ludo@gnu.org>
+;;; Copyright © 2015 Alex Kost <alezost@gmail.com>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -45,6 +46,7 @@
             upstream-updater
             upstream-updater?
             upstream-updater-name
+            upstream-updater-description
             upstream-updater-predicate
             upstream-updater-latest
 
@@ -109,18 +111,19 @@ correspond to the same version."
 ;;; Auto-update.
 ;;;
 
-(define-record-type <upstream-updater>
-  (upstream-updater name pred latest)
+(define-record-type* <upstream-updater>
+  upstream-updater make-upstream-updater
   upstream-updater?
-  (name      upstream-updater-name)
-  (pred      upstream-updater-predicate)
-  (latest    upstream-updater-latest))
+  (name        upstream-updater-name)
+  (description upstream-updater-description)
+  (pred        upstream-updater-predicate)
+  (latest      upstream-updater-latest))
 
 (define (lookup-updater package updaters)
   "Return an updater among UPDATERS that matches PACKAGE, or #f if none of
 them matches."
   (any (match-lambda
-         (($ <upstream-updater> _ pred latest)
+         (($ <upstream-updater> _ _ pred latest)
           (and (pred package) latest)))
        updaters))
 
-- 
2.5.0