[bug#53548] [PATCH] Harden beautify-description

[Alice BRENON]

Hi !

Thank you again for the help. I think it looks really better with the
translated reference to the info page. I feared the issues I raised
would yield unending discussions but actually with your edit it's
already pretty neat while remaining very simple. That's inspiring.

For the others interested in this thread, I also made the import of G_
from (guix i18n) explicit because it was being re-exported from (guix
ui), and while I was at it, I made the only used import from (guix ui),
that is fill-paragraph, explicit.

Hope you like this second version better : )

Alice


Le Tue, 01 Feb 2022 00:09:40 +0100,
Ludovic Courtès <ludo@gnu.org> a écrit :

> Hi Alice,
> 
> Alice BRENON <alice.brenon@ens-lyon.fr> skribis:
> 
> > Missing metadata in packages used to break their imports, at least
> > for opam packages, until this was fixed by Julien in
> > 24aa7b3c21309b63cc6e8e18d6417d2cddccf6c6. When Xinglu improved the
> > output of descriptions in 155fc235b5e1b41b4665c782365dd2bf11beae9c,
> > it made the imports break again in the case when the `description`
> > field is missing and Julien's fix applies, returning #f in
> > `metadata-ref` instead of crashing. Trouble is:
> > beautify-description expects its description argument to be a
> > string and will crash if this assumption isn't met (when calling
> > the `string-prefix?` predicate).  
> 
> Thanks for explaining!  Some comments:
> 
> > From 22f0523ef3599b45af9448bd4f31f7b8f8ce6af2 Mon Sep 17 00:00:00
> > 2001 From: Alice BRENON <alice.brenon@ens-lyon.fr>
> > Date: Wed, 26 Jan 2022 09:27:12 +0100
> > Subject: [PATCH] guix: import: Harden beautify-description.
> >
> > * guix/import/utils.scm (beautify-description): Handle non-string
> > arguments.
> > * guix/import/opam.scm: [use-modules] Make imports explicit for
> > module (guix import utils).  
> 
> [...]
> 
> >    #:use-module ((guix utils) #:select (cache-directory  
> >                                         version>?  
> >                                         call-with-temporary-output-file))
> > -  #:use-module (guix import utils)
> > +  #:use-module ((guix import utils) #:select (beautify-description
> > +                                              guix-hash-url
> > +                                              recursive-import
> > +                                              spdx-string->license
> > +                                              url-fetch))  
> 
> It can’t hurt.
> 
> > +                  ((not (string? description))
> > +                   (let ((home-url "https://guix.gnu.org/";)
> > +                         (doc-path "fr/manual/devel/en/html_node/")
> > +                         (page
> > +
> > "Synopses-and-Descriptions.html#Synopses-and-Descriptions"))
> > +                     (string-append
> > +                       "Please fill in the description of your
> > package before "
> > +                       "submitting ! See "
> > +                       home-url doc-path page)))  
> 
> I’d avoid the URL and maybe make the string translatable, like so:
> 
>   (G_ "This package lacks a description …
> Run \"info '(guix) Synopses and Descriptions'\" for more
> information.")
> 
> … where ‘G_’ comes from (guix i18n).
> 
> WDYT?
> 
> This looks like a welcome improvement to me.
> 
> Thanks!
> 
> Ludo’.

0001-guix-import-Harden-beautify-description.patch
Description: Text Data