GNU bug report logs - #41265
[PATCH] guix describe: Add '--list-formats'

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 41265 in the body.
You can then email your comments to 41265 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Ekaitz Zarraga <ekaitz <at> elenq.tech>
To: "guix-patches <at> gnu.org" <guix-patches <at> gnu.org>
Subject: [PATCH] guix describe: Add '--list-formats'
Date: Thu, 14 May 2020 15:30:40 +0000

Hi,

Added `--list-formats` option to `guix describe` in order to improve user experience as discussed here:

https://lists.nongnu.org/archive/html/guix-devel/2020-05/msg00215.html

Hope it's useful.

Ekaitz
---


From 75f16431475fb692228f69be06baa635eb6fa5b7 Mon Sep 17 00:00:00 2001
From: Ekaitz Zarraga <ekaitz <at> elenq.tech>
Date: Thu, 14 May 2020 17:25:03 +0200
Subject: [PATCH] guix describe: Add '--list-formats'

    * guix/scripts/describe.scm (%available-formats): New variable.
    (list-fortmats): New procedure.
    (%options, show-help): Add --list-formats
---
 guix/scripts/describe.scm | 18 +++++++++++++++++-
 1 file changed, 17 insertions(+), 1 deletion(-)

diff --git a/guix/scripts/describe.scm b/guix/scripts/describe.scm
index f13f221da9..029098cea2 100644
--- a/guix/scripts/describe.scm
+++ b/guix/scripts/describe.scm
@@ -1,6 +1,7 @@
 ;;; GNU Guix --- Functional package management for GNU
 ;;; Copyright © 2018, 2019, 2020 Ludovic Courtès <ludo <at> gnu.org>
 ;;; Copyright © 2018 Oleg Pykhalov <go.wigust <at> gmail.com>
+;;; Copyright © 2020 Ekaitz Zarraga <ekaitz <at> elenq.tech>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -42,13 +43,26 @@
 ;;; Command-line options.
 ;;;

+(define %available-formats '("human" "channels" "json" "recutils"))
+
+(define (list-formats)
+  (display (G_ "The available formats are:\n"))
+  (newline)
+  (for-each (lambda (f)
+              (format #t "  - ~a~%" f))
+            %available-formats))
+
 (define %options
   ;; Specifications of the command-line options.
   (list (option '(#\f "format") #t #f
                 (lambda (opt name arg result)
-                  (unless (member arg '("human" "channels" "json" "recutils"))
+                  (unless (member arg %available-formats)
                     (leave (G_ "~a: unsupported output format~%") arg))
                   (alist-cons 'format (string->symbol arg) result)))
+        (option '("list-formats") #f #f
+                (lambda (opt name arg result)
+                  (list-formats)
+                  (exit 0)))
         (option '(#\p "profile") #t #f
                 (lambda (opt name arg result)
                   (alist-cons 'profile (canonicalize-profile arg)
@@ -70,6 +84,8 @@
 Display information about the channels currently in use.\n"))
   (display (G_ "
   -f, --format=FORMAT    display information in the given FORMAT"))
+  (display (G_ "
+      --list-formats     display available formats"))
   (display (G_ "
   -p, --profile=PROFILE  display information about PROFILE"))
   (newline)
--
2.26.1

Message #8 received at 41265 <at> debbugs.gnu.org (full text, mbox):

From: Ludovic Courtès <ludo <at> gnu.org>
To: Ekaitz Zarraga <ekaitz <at> elenq.tech>
Cc: 41265 <at> debbugs.gnu.org
Subject: Re: [bug#41265] [PATCH] guix describe: Add '--list-formats'
Date: Sat, 16 May 2020 19:35:32 +0200

Ekaitz Zarraga <ekaitz <at> elenq.tech> skribis:

>>From 75f16431475fb692228f69be06baa635eb6fa5b7 Mon Sep 17 00:00:00 2001
> From: Ekaitz Zarraga <ekaitz <at> elenq.tech>
> Date: Thu, 14 May 2020 17:25:03 +0200
> Subject: [PATCH] guix describe: Add '--list-formats'
>
>     * guix/scripts/describe.scm (%available-formats): New variable.
>     (list-fortmats): New procedure.
              ^^
Typo.

>     (%options, show-help): Add --list-formats

Could you also add the option to doc/guix.texi?

TIA!

Ludo’.

Message #11 received at 41265 <at> debbugs.gnu.org (full text, mbox):

From: Ekaitz Zarraga <ekaitz <at> elenq.tech>
To: Ludovic Courtès <ludo <at> gnu.org>
Cc: "41265 <at> debbugs.gnu.org" <41265 <at> debbugs.gnu.org>
Subject: Re: [bug#41265] [PATCH] guix describe: Add '--list-formats'
Date: Sat, 16 May 2020 18:01:23 +0000

‐‐‐‐‐‐‐ Original Message ‐‐‐‐‐‐‐
On Saturday, May 16, 2020 7:35 PM, Ludovic Courtès <ludo <at> gnu.org> wrote:

> Ekaitz Zarraga ekaitz <at> elenq.tech skribis:
>
> > > From 75f16431475fb692228f69be06baa635eb6fa5b7 Mon Sep 17 00:00:00 2001
> > > From: Ekaitz Zarraga ekaitz <at> elenq.tech
> > > Date: Thu, 14 May 2020 17:25:03 +0200
> > > Subject: [PATCH] guix describe: Add '--list-formats'
> >
> >     * guix/scripts/describe.scm (%available-formats): New variable.
> >     (list-fortmats): New procedure.
> >
>
>               ^^
>
>
> Typo.
>
> >     (%options, show-help): Add --list-formats
> >
>
> Could you also add the option to doc/guix.texi?
>
> TIA!
>
> Ludo’.

There it goes, not sure if I added it right to the docs, never edited a texi before :)

Cheers!

From f7af79434eb702140ddadb321a4fcaaf197dbf45 Mon Sep 17 00:00:00 2001
From: Ekaitz Zarraga <ekaitz <at> elenq.tech>
Date: Sat, 16 May 2020 19:57:18 +0200
Subject: [PATCH] guix describe: Add '--list-formats'

    * guix/scripts/describe.scm (%available-formats): New variable.
    (list-formats): New procedure.
    (%options, show-help): Add --list-formats
    * doc/guix.texi: Add --list-formats
---
 doc/guix.texi             |  3 +++
 guix/scripts/describe.scm | 17 ++++++++++++++++-
 2 files changed, 19 insertions(+), 1 deletion(-)

diff --git a/doc/guix.texi b/doc/guix.texi
index d043852ac3..de2cbdf6e5 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -4475,6 +4475,9 @@ produce a list of channel specifications in JSON format;
 produce a list of channel specifications in Recutils format.
 @end table

+@item --list-formats
+Display available formats for @option{--format} option.
+
 @item --profile=@var{profile}
 @itemx -p @var{profile}
 Display information about @var{profile}.
diff --git a/guix/scripts/describe.scm b/guix/scripts/describe.scm
index f13f221da9..7a2dbc453a 100644
--- a/guix/scripts/describe.scm
+++ b/guix/scripts/describe.scm
@@ -1,6 +1,7 @@
 ;;; GNU Guix --- Functional package management for GNU
 ;;; Copyright © 2018, 2019, 2020 Ludovic Courtès <ludo <at> gnu.org>
 ;;; Copyright © 2018 Oleg Pykhalov <go.wigust <at> gmail.com>
+;;; Copyright © 2020 Ekaitz Zarraga <ekaitz <at> elenq.tech>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -41,14 +42,26 @@
 ;;;
 ;;; Command-line options.
 ;;;
+(define %available-formats '("human" "channels" "json" "recutils"))
+
+(define (list-formats)
+  (display (G_ "The available formats are:\n"))
+  (newline)
+  (for-each (lambda (f)
+              (format #t "  - ~a~%" f))
+            %available-formats))

 (define %options
   ;; Specifications of the command-line options.
   (list (option '(#\f "format") #t #f
                 (lambda (opt name arg result)
-                  (unless (member arg '("human" "channels" "json" "recutils"))
+                  (unless (member arg %available-formats)
                     (leave (G_ "~a: unsupported output format~%") arg))
                   (alist-cons 'format (string->symbol arg) result)))
+        (option '("list-formats") #f #f
+                (lambda (opt name arg result)
+                  (list-formats)
+                  (exit 0)))
         (option '(#\p "profile") #t #f
                 (lambda (opt name arg result)
                   (alist-cons 'profile (canonicalize-profile arg)
@@ -70,6 +83,8 @@
 Display information about the channels currently in use.\n"))
   (display (G_ "
   -f, --format=FORMAT    display information in the given FORMAT"))
+  (display (G_ "
+      --list-formats     display available formats"))
   (display (G_ "
   -p, --profile=PROFILE  display information about PROFILE"))
   (newline)
--
2.26.1

Message #16 received at 41265-done <at> debbugs.gnu.org (full text, mbox):

From: Ludovic Courtès <ludo <at> gnu.org>
To: Ekaitz Zarraga <ekaitz <at> elenq.tech>
Cc: "41265 <at> debbugs.gnu.org" <41265-done <at> debbugs.gnu.org>
Subject: Re: [bug#41265] [PATCH] guix describe: Add '--list-formats'
Date: Mon, 18 May 2020 14:32:33 +0200

Hi,

Ekaitz Zarraga <ekaitz <at> elenq.tech> skribis:

>>From f7af79434eb702140ddadb321a4fcaaf197dbf45 Mon Sep 17 00:00:00 2001
> From: Ekaitz Zarraga <ekaitz <at> elenq.tech>
> Date: Sat, 16 May 2020 19:57:18 +0200
> Subject: [PATCH] guix describe: Add '--list-formats'
>
>     * guix/scripts/describe.scm (%available-formats): New variable.
>     (list-formats): New procedure.
>     (%options, show-help): Add --list-formats
>     * doc/guix.texi: Add --list-formats

I removed the leading space above and applied it.  Thank you!

Ludo’.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.