[bug#58972] [PATCH 0/3] Improve output descriptions

[bug#58972] [PATCH 0/3] Improve output descriptions

[Liliana Marie Prikler]

Hi Guix,

this has some improvements for package->recutils recently discussed in IRC.

Cheers

Liliana Marie Prikler (3):
  guix: ui: Handle single outputs.
  guix: ui: Use a shrug emoji when missing output descriptions.
  guix: ui: Add default synopsis for “doc” output.

 guix/ui.scm | 32 ++++++++++++++++++++++----------
 1 file changed, 22 insertions(+), 10 deletions(-)

-- 
2.38.0

[bug#58972] [PATCH 1/3] guix: ui: Handle single outputs.

[Liliana Marie Prikler]

The current code says "out" contains "everything else", even if there's no
other output to contain anything.

* guix/ui.scm (package->recutils)[default-output-synopses]: New variable.
[output->recutils]: Take default synopses as argument.
["outputs"]: Distinguish single and multiple outputs.
---
 guix/ui.scm | 29 ++++++++++++++++++++---------
 1 file changed, 20 insertions(+), 9 deletions(-)

diff --git a/guix/ui.scm b/guix/ui.scm
index dad2b853ac..60b09bf6e4 100644
--- a/guix/ui.scm
+++ b/guix/ui.scm
@@ -1512,7 +1512,15 @@ (define (dependencies->recutils packages)
                                    (sort packages package<?))) " ")))
       (split-lines list (string-length "dependencies: "))))
 
-  (define (output->recutils package output)
+  (define %default-output-synopses
+    `(("bin" . ,(G_ "executable programs and scripts"))
+      ("debug" . ,(G_ "debug information"))
+      ("lib" . ,(G_ "shared libraries"))
+      ("static" . ,(G_ "static libraries"))
+      ("out" . ,(G_ "everything else"))))
+
+  (define* (output->recutils package output #:optional
+                             (default-synopses %default-output-synopses))
     (string-append
      "+ " output ": "
      (or
@@ -1522,12 +1530,7 @@ (define (output->recutils package output)
           (and (string=? key output) (P_ synopsis)))
          (_ #f))
        (package-properties package))
-      (assoc-ref `(("bin" . ,(G_ "executable programs and scripts"))
-                   ("debug" . ,(G_ "debug information"))
-                   ("lib" . ,(G_ "shared libraries"))
-                   ("static" . ,(G_ "static libraries"))
-                   ("out" . ,(G_ "everything else")))
-                 output)
+      (assoc-ref default-synopses output)
       (G_ "see Appendix H"))))
 
   (define (package-outputs/out-last package)
@@ -1546,8 +1549,16 @@ (define highlighting*
   ;; Note: Don't i18n field names so that people can post-process it.
   (format port "name: ~a~%" (highlight (package-name p) port*))
   (format port "version: ~a~%" (highlight (package-version p) port*))
-  (format port "outputs:~%~{~a~%~}"
-          (map (cut output->recutils p <>) (package-outputs/out-last p)))
+  (match (package-outputs/out-last p)
+    (("out")                            ; one output has everything
+     (format port "outputs:~%~a~%"
+             (output->recutils p "out"
+                               (cons `("out" . ,(G_ "everything"))
+                                     %default-output-synopses))))
+    (outputs                            ; multiple outputs
+     (format port "outputs:~%~{~a~%~}"
+             (map (cut output->recutils p <>) (package-outputs/out-last p)))))
+
   (format port "systems: ~a~%"
           (split-lines (string-join (package-transitive-supported-systems p))
                        (string-length "systems: ")))
-- 
2.38.0

[bug#58972] [PATCH 1/3] guix: ui: Handle single outputs.

[zimoun]

Hi,

On Wed, 02 Nov 2022 at 21:01, Liliana Marie Prikler <liliana.prikler@gmail.com> wrote:

> The current code says "out" contains "everything else", even if there's no
> other output to contain anything.
>
> * guix/ui.scm (package->recutils)[default-output-synopses]: New variable.
> [output->recutils]: Take default synopses as argument.
> ["outputs"]: Distinguish single and multiple outputs.
> ---
>  guix/ui.scm | 29 ++++++++++++++++++++---------
>  1 file changed, 20 insertions(+), 9 deletions(-)

LGTM.


> +  (define %default-output-synopses

[...]

> +      ("out" . ,(G_ "everything else"))))
> +
> +  (define* (output->recutils package output #:optional
> +                             (default-synopses %default-output-synopses))

[...]

> +      (assoc-ref default-synopses output)

Out of curiosity…

> +  (match (package-outputs/out-last p)
> +    (("out")                            ; one output has everything
> +     (format port "outputs:~%~a~%"
> +             (output->recutils p "out"
> +                               (cons `("out" . ,(G_ "everything"))
> +                                     %default-output-synopses))))

…is this ’cons’ instead of deletion because of performance?


Cheers,
simon

[bug#58972] [PATCH 1/3] guix: ui: Handle single outputs.

[Liliana Marie Prikler]

Am Donnerstag, dem 03.11.2022 um 10:01 +0100 schrieb zimoun:
> Hi,
> 
> On Wed, 02 Nov 2022 at 21:01, Liliana Marie Prikler
> <liliana.prikler@gmail.com> wrote:
> 
> > The current code says "out" contains "everything else", even if
> > there's no
> > other output to contain anything.
> > 
> > * guix/ui.scm (package->recutils)[default-output-synopses]: New
> > variable.
> > [output->recutils]: Take default synopses as argument.
> > ["outputs"]: Distinguish single and multiple outputs.
> > ---
> >  guix/ui.scm | 29 ++++++++++++++++++++---------
> >  1 file changed, 20 insertions(+), 9 deletions(-)
> 
> LGTM.
> 
> 
> > +  (define %default-output-synopses
> 
> [...]
> 
> > +      ("out" . ,(G_ "everything else"))))
> > +
> > +  (define* (output->recutils package output #:optional
> > +                             (default-synopses %default-output-
> > synopses))
> 
> [...]
> 
> > +      (assoc-ref default-synopses output)
> 
> Out of curiosity…
> 
> > +  (match (package-outputs/out-last p)
> > +    (("out")                            ; one output has
> > everything
> > +     (format port "outputs:~%~a~%"
> > +             (output->recutils p "out"
> > +                               (cons `("out" . ,(G_ "everything"))
> > +                                     %default-output-synopses))))
> 
> …is this ’cons’ instead of deletion because of performance?
It makes no functional difference and we only want non-destructive
changes.  That being said, perhaps alist-cons should have been used
instead.

Cheers

[bug#58972] [PATCH v2 1/3] guix: ui: Handle single outputs.

[Liliana Marie Prikler]

The current code says "out" contains "everything else", even if there's no
other output to contain anything.

* guix/ui.scm (package->recutils)[default-output-synopses]: New variable.
[output->recutils]: Take default synopses as argument.
["outputs"]: Distinguish single and multiple outputs.
---
 guix/ui.scm | 29 ++++++++++++++++++++---------
 1 file changed, 20 insertions(+), 9 deletions(-)

diff --git a/guix/ui.scm b/guix/ui.scm
index dad2b853ac..0f9a4dc187 100644
--- a/guix/ui.scm
+++ b/guix/ui.scm
@@ -1512,7 +1512,15 @@ (define (dependencies->recutils packages)
                                    (sort packages package<?))) " ")))
       (split-lines list (string-length "dependencies: "))))
 
-  (define (output->recutils package output)
+  (define %default-output-synopses
+    `(("bin" . ,(G_ "executable programs and scripts"))
+      ("debug" . ,(G_ "debug information"))
+      ("lib" . ,(G_ "shared libraries"))
+      ("static" . ,(G_ "static libraries"))
+      ("out" . ,(G_ "everything else"))))
+
+  (define* (output->recutils package output #:optional
+                             (default-synopses %default-output-synopses))
     (string-append
      "+ " output ": "
      (or
@@ -1522,12 +1530,7 @@ (define (output->recutils package output)
           (and (string=? key output) (P_ synopsis)))
          (_ #f))
        (package-properties package))
-      (assoc-ref `(("bin" . ,(G_ "executable programs and scripts"))
-                   ("debug" . ,(G_ "debug information"))
-                   ("lib" . ,(G_ "shared libraries"))
-                   ("static" . ,(G_ "static libraries"))
-                   ("out" . ,(G_ "everything else")))
-                 output)
+      (assoc-ref default-synopses output)
       (G_ "see Appendix H"))))
 
   (define (package-outputs/out-last package)
@@ -1546,8 +1549,16 @@ (define highlighting*
   ;; Note: Don't i18n field names so that people can post-process it.
   (format port "name: ~a~%" (highlight (package-name p) port*))
   (format port "version: ~a~%" (highlight (package-version p) port*))
-  (format port "outputs:~%~{~a~%~}"
-          (map (cut output->recutils p <>) (package-outputs/out-last p)))
+  (match (package-outputs/out-last p)
+    (("out")                            ; one output has everything
+     (format port "outputs:~%~a~%"
+             (output->recutils p "out"
+                               (alist-cons "out" (G_ "everything")
+                                           %default-output-synopses))))
+    (outputs                            ; multiple outputs
+     (format port "outputs:~%~{~a~%~}"
+             (map (cut output->recutils p <>) (package-outputs/out-last p)))))
+
   (format port "systems: ~a~%"
           (split-lines (string-join (package-transitive-supported-systems p))
                        (string-length "systems: ")))
-- 
2.38.0

[bug#58972] [PATCH v2 1/3] guix: ui: Handle single outputs.

[Ludovic Courtès]

Liliana Marie Prikler <liliana.prikler@gmail.com> skribis:

> The current code says "out" contains "everything else", even if there's no
> other output to contain anything.
>
> * guix/ui.scm (package->recutils)[default-output-synopses]: New variable.
> [output->recutils]: Take default synopses as argument.
> ["outputs"]: Distinguish single and multiple outputs.

LGTM!

[bug#58972] [PATCH 2/3] guix: ui: Use a shrug emoji when missing output descriptions.

[Liliana Marie Prikler]

The current reference to Intel's Appendix H appears too obscure and confusing.

* guix/ui.scm (package->recutils)[output->recutils]: Replace “see Appendix H”
with “‾\_(ツ)_/‾”.
---
 guix/ui.scm | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/guix/ui.scm b/guix/ui.scm
index 60b09bf6e4..e177c3badc 100644
--- a/guix/ui.scm
+++ b/guix/ui.scm
@@ -1531,7 +1531,7 @@ (define* (output->recutils package output #:optional
          (_ #f))
        (package-properties package))
       (assoc-ref default-synopses output)
-      (G_ "see Appendix H"))))
+      (G_ "‾\\_(ツ)_/‾"))))
 
   (define (package-outputs/out-last package)
     ((compose append partition)
-- 
2.38.0

[bug#58972] [PATCH 2/3] guix: ui: Use a shrug emoji when missing output descriptions.

[( via Guix-patches via]

On Wed Nov 2, 2022 at 8:10 PM GMT, Liliana Marie Prikler wrote:
> +      (G_ "‾\\_(ツ)_/‾"))))
               ^^
There's two slashes here ;)

    -- (

[bug#58972] [PATCH 2/3] guix: ui: Use a shrug emoji when missing output descriptions.

[( via Guix-patches via]

On Wed Nov 2, 2022 at 8:51 PM GMT, ( via Guix-patches via wrote:
> There's two slashes here ;)

...never mind, it's a backslash escape /o\

    -- (

[bug#58972] [PATCH 2/3] guix: ui: Use a shrug emoji when missing output descriptions.

[zimoun]

Hi,

On Wed, 02 Nov 2022 at 21:10, Liliana Marie Prikler <liliana.prikler@gmail.com> wrote:

> -      (G_ "see Appendix H"))))
> +      (G_ "‾\\_(ツ)_/‾"))))

As I commented in #54454 [1], the plain “undocumented” should appear
because it is explicit.  For instance,

      (G_ "undocumented ‾\\_(ツ)_/‾"))))


1: <https://issues.guix.gnu.org/issue/54454#msgid-b291660275aa551cacdca066e4b988c07bbbe944>

Cheers
simon

[bug#58972] [PATCH 2/3] guix: ui: Use a shrug emoji when missing output descriptions.

[Ludovic Courtès]

Hi,

Liliana Marie Prikler <liliana.prikler@gmail.com> skribis:

> -      (G_ "see Appendix H"))))
> +      (G_ "‾\\_(ツ)_/‾"))))

I would just make it "(description unavailable)".

It’s boring, I know, but (1) it’s consistent with the rest of the UI,
and (2) it doesn’t require Unicode-capable displays.

Ludo’.

[bug#58972] [PATCH v2 2/3] guix: ui: Improve missing output descriptions.

[Liliana Marie Prikler]

The current reference to Intel's Appendix H appears too obscure and confusing.

* guix/ui.scm (package->recutils)[output->recutils]: Replace “see Appendix H”
with “[description missing]”.
---
 guix/ui.scm | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/guix/ui.scm b/guix/ui.scm
index 0f9a4dc187..6299ba77a1 100644
--- a/guix/ui.scm
+++ b/guix/ui.scm
@@ -1531,7 +1531,7 @@ (define* (output->recutils package output #:optional
          (_ #f))
        (package-properties package))
       (assoc-ref default-synopses output)
-      (G_ "see Appendix H"))))
+      (G_ "[description missing]"))))
 
   (define (package-outputs/out-last package)
     ((compose append partition)
-- 
2.38.0

[bug#58972] [PATCH v2 2/3] guix: ui: Improve missing output descriptions.

[Ludovic Courtès]

Liliana Marie Prikler <liliana.prikler@gmail.com> skribis:

> The current reference to Intel's Appendix H appears too obscure and confusing.
>
> * guix/ui.scm (package->recutils)[output->recutils]: Replace “see Appendix H”
> with “[description missing]”.
> ---
>  guix/ui.scm | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/guix/ui.scm b/guix/ui.scm
> index 0f9a4dc187..6299ba77a1 100644
> --- a/guix/ui.scm
> +++ b/guix/ui.scm
> @@ -1531,7 +1531,7 @@ (define* (output->recutils package output #:optional
>           (_ #f))
>         (package-properties package))
>        (assoc-ref default-synopses output)
> -      (G_ "see Appendix H"))))
> +      (G_ "[description missing]"))))

LGTM, thanks!

Ludo’.

[bug#58972] [PATCH 3/3] guix: ui: Add default synopsis for “doc” output.

[Liliana Marie Prikler]

* guix/ui.scm (package->recutils)[%default-output-synopses]: Add “doc”.
---
 guix/ui.scm | 1 +
 1 file changed, 1 insertion(+)

diff --git a/guix/ui.scm b/guix/ui.scm
index e177c3badc..309ffcb908 100644
--- a/guix/ui.scm
+++ b/guix/ui.scm
@@ -1515,6 +1515,7 @@ (define (dependencies->recutils packages)
   (define %default-output-synopses
     `(("bin" . ,(G_ "executable programs and scripts"))
       ("debug" . ,(G_ "debug information"))
+      ("doc" . ,(G_ "documentation"))
       ("lib" . ,(G_ "shared libraries"))
       ("static" . ,(G_ "static libraries"))
       ("out" . ,(G_ "everything else"))))
-- 
2.38.0

[bug#58972] [PATCH 3/3] guix: ui: Add default synopsis for “doc” output.

[zimoun]

Hi,

On Wed, 02 Nov 2022 at 21:16, Liliana Marie Prikler <liliana.prikler@gmail.com> wrote:
> * guix/ui.scm (package->recutils)[%default-output-synopses]: Add “doc”.
> ---
>  guix/ui.scm | 1 +
>  1 file changed, 1 insertion(+)

LGTM.

Cheers,
simon

[bug#58972] [PATCH 3/3] guix: ui: Add default synopsis for “doc” output.

[Ludovic Courtès]

zimoun <zimon.toutoune@gmail.com> skribis:

> On Wed, 02 Nov 2022 at 21:16, Liliana Marie Prikler <liliana.prikler@gmail.com> wrote:
>> * guix/ui.scm (package->recutils)[%default-output-synopses]: Add “doc”.
>> ---
>>  guix/ui.scm | 1 +
>>  1 file changed, 1 insertion(+)
>
> LGTM.

+1

bug#58972: [PATCH 3/3] guix: ui: Add default synopsis for “doc” output.

[Liliana Marie Prikler]

Am Donnerstag, dem 03.11.2022 um 16:06 +0100 schrieb Ludovic Courtès:
> zimoun <zimon.toutoune@gmail.com> skribis:
> 
> > On Wed, 02 Nov 2022 at 21:16, Liliana Marie Prikler
> > <liliana.prikler@gmail.com> wrote:
> > > * guix/ui.scm (package->recutils)[%default-output-synopses]: Add
> > > “doc”.
> > > ---
> > >  guix/ui.scm | 1 +
> > >  1 file changed, 1 insertion(+)
> > 
> > LGTM.
> 
> +1
Pushed now.

Cheers

[bug#58972] [PATCH v2 3/3] guix: ui: Add default synopsis for “doc” output.

[Liliana Marie Prikler]

* guix/ui.scm (package->recutils)[%default-output-synopses]: Add “doc”.
---
 guix/ui.scm | 1 +
 1 file changed, 1 insertion(+)

diff --git a/guix/ui.scm b/guix/ui.scm
index 6299ba77a1..45eccb7335 100644
--- a/guix/ui.scm
+++ b/guix/ui.scm
@@ -1515,6 +1515,7 @@ (define (dependencies->recutils packages)
   (define %default-output-synopses
     `(("bin" . ,(G_ "executable programs and scripts"))
       ("debug" . ,(G_ "debug information"))
+      ("doc" . ,(G_ "documentation"))
       ("lib" . ,(G_ "shared libraries"))
       ("static" . ,(G_ "static libraries"))
       ("out" . ,(G_ "everything else"))))
-- 
2.38.0

[bug#58972] [PATCH v2 3/3] guix: ui: Add default synopsis for “doc” output.

[zimoun]

Hi Liliana,

All the series LGTM.

Cheers,
simon