unofficial mirror of guix-patches@gnu.org 
 help / color / mirror / code / Atom feed
From: Nicolas Goaziou <mail@nicolasgoaziou.fr>
To: Baptiste Strazzulla <bstrazzull@hotmail.fr>
Cc: 52027@debbugs.gnu.org
Subject: [bug#52027] [PATCH] Add lz4json
Date: Sun, 21 Nov 2021 21:27:28 +0100	[thread overview]
Message-ID: <87tug5uudr.fsf@nicolasgoaziou.fr> (raw)
In-Reply-To: <PA4PR03MB7101460B8ABA8E1330BF86F2B99E9@PA4PR03MB7101.eurprd03.prod.outlook.com> (Baptiste Strazzulla's message of "Sun, 21 Nov 2021 19:55:22 +0000")

Hello,

Baptiste Strazzulla <bstrazzull@hotmail.fr> writes:

> I couldn't figure out a license for this package. It says " *
> Copyright (c) 2014 Intel Corporation" in the source. I don't even know
> if it's an actual license.
> In any case, it doesn't seem really
> engaging and there's no mention of it in `licenses.scm`… How shall
> I proceed?

The license is below, in the lz4jsoncat.c header. It's bsd-2


> +(define-public lz4json
> +  (package
> +    (name "lz4json")
> +    (version "2")
> +    (home-page "https://github.com/andikleen/lz4json")

This should be moved right before the synopsis field.

> +    (source
> +     (origin
> +       (method git-fetch)
> +       (uri
> +        (git-reference (url home-page) (commit (string-append "v" version))))

(url ...) should provide the github URL and not re-use the home-page.
Also there should be newline characters before and after the url field.

> +    (arguments
> +     '(#:phases
> +       (modify-phases %standard-phases
> +         (delete 'configure)
> +         (delete 'check)
> +         (replace 'install

Could you add comment explaining why 'configure' is deleted (probably
because there is no configure script) and 'install' is replaced
(probably because upstream provides no install script either).

Instead of deleting `check', you should use:

  #:tests? #false

instead.

> +           (lambda* (#:key outputs #:allow-other-keys)
> +             (let* ((out (assoc-ref outputs "out"))
> +                    (bin (string-append out "/bin"))
> +                    (man (string-append out "/share/man/man1")))
> +               (install-file "lz4jsoncat" bin)
> +               (install-file "lz4jsoncat.1" man))
> +             #t)))

You can remove the trailing boolean at the end of the phase.

> +       #:make-flags '("CC=gcc")))

The above is not cross-compilation friendly. It should become

  `(,(string-append "CC=" (cc-for-target)))

instead.

> +    (synopsis "C decompress tool for mozilla lz4json format")
> +    (description
> +     "A little utility to unpack lz4json files as generated by Firefox's
> +bookmark backups and session restore.  This is a different format from what
> +the normal lz4 utility expects.  The data is dumped to stdout.")

The description should consist of full sentences. So it may start as

  @code{lz4json} is a little utility to unpack lz4json files…

> +    (license license:gpl3+)))

This should be license:bsd-2.

Thanks for your work. Could you send an updated patch?

Regards,
-- 
Nicolas Goaziou




  reply	other threads:[~2021-11-21 20:28 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-11-21 19:55 [bug#52027] [PATCH] Add lz4json Baptiste Strazzulla
2021-11-21 20:27 ` Nicolas Goaziou [this message]
2021-11-21 21:54 ` Baptiste Strazzulla
2021-11-22 10:24   ` bug#52027: " Nicolas Goaziou

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://guix.gnu.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87tug5uudr.fsf@nicolasgoaziou.fr \
    --to=mail@nicolasgoaziou.fr \
    --cc=52027@debbugs.gnu.org \
    --cc=bstrazzull@hotmail.fr \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/guix.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).