[bug#35086] New package file for BOINC client & server

This is my first submission for contributing to Guix, so any feedback or advice is welcomed!

Thank you,

--
Brant Gardner

Hello Brant,

"Brant Gardner" <brantcgardner@brantware.com> skribis:

> This is my first submission for contributing to Guix, so any feedback or advice is welcomed!

Thanks for joining!

I have some suggestions below, but overall its a great start!

> From 2946bd1c83a2ea224841d22463992be599dfc385 Mon Sep 17 00:00:00 2001
> From: Brant Gardner <brantcgardner@brantware.com>
> Date: Tue, 2 Apr 2019 11:09:45 -0500
> Subject: [PATCH] Added distributed.scm
>
> New package file for BOINC and other distributed-computing projects.  This
> initial file just includes boinc-client and boinc-server, both at version
> 7.14.2.

The convention is to write commit logs in ChangeLog format, as
described at:

  https://www.gnu.org/prep/standards/html_node/Change-Logs.html

But you can simply look at git log and mimic what you see.  (You might
also want to take a look at
<https://gnu.org/software/guix/manual/en/html_node/Submitting-Patches.html>
if you havent already.)

As for the module name, what about boinc.scm instead?  Distributed
sounds a bit too generic to me.

> +++ b/gnu/packages/distributed.scm
> @@ -0,0 +1,119 @@
> +;;; GNU Guix --- Functional package management for GNU
> +;;; Copyright .© 2014, 2015 Ludovic Court.¨s <ludo@gnu.org>
> +;;; Copyright .© 2016, 2017, 2018, 2019 Efraim Flashner <efraim@flashner.co.il>
> +;;; Copyright .© 2018 Tobias Geerinckx-Rice <me@tobias.gr>
> +;;; Copyright .© 2018 Mathieu Othacehe <m.othacehe@gmail.com>

It should be just you here.  :-)

> +  #:use-module (gnu packages autotools)
> +  #:use-module (gnu packages base)
> +  #:use-module (gnu packages compression)
> +  #:use-module (gnu packages databases)
> +  #:use-module (gnu packages pkg-config)
> +  #:use-module (gnu packages tls)
> +  #:use-module (gnu packages curl)
> +  #:use-module (gnu packages wxwidgets)
> +  #:use-module (gnu packages gnome)
> +  #:use-module (gnu packages gtk)
> +  #:use-module (gnu packages perl)
> +  #:use-module (gnu packages sqlite)
> +  #:use-module (gnu packages python)
> +  #:use-module (gnu packages python-xyz))

I think you can trim this list.

> +    (synopsis "BOINC lets you help cutting-edge science research using your computer")

What about something like Contribute computing power to research projects?

> +    (description "BOINC is a platform for high-throughput computing on a large
> +scale (thousands or millions of computers).  It can be used for volunteer
> +computing (using consumer devices) or grid computing (using organizational
> +resources).  It supports virtualized, parallel, and GPU-based applications.
> +
> +BOINC is distributed under the LGPL open source license.  It can be used for
> +commercial purposes, and applications need not be open source.")

This last paragraph is unnecessary: everything in Guix is free software,
so we never mention it in descriptions.

> +    (synopsis "BOINC lets you help cutting-edge science research using your computer")
> +    (description "BOINC is a platform for high-throughput computing on a large
> +scale (thousands or millions of computers).  It can be used for volunteer
> +computing (using consumer devices) or grid computing (using organizational
> +resources).  It supports virtualized, parallel, and GPU-based applications.

It would be nice to have a slightly different synopsis and description
for the server and for the client.

Apart from that it LGTM!  Could you double check that guix lint is
happy and send an updated patch?

Thank you!

Ludo.

Good afternoon;

On Wed, Apr 10, 2019, at 10:06, Ludovic Courtès wrote:
> Hello Brant,
> 
> "Brant Gardner" <brantcgardner@brantware.com> skribis:
> 
> > This is my first submission for contributing to Guix, so any feedback or advice is welcomed!
> 
> Thanks for joining!
> 
> I have some suggestions below, but overall its a great start!
> 
> > From 2946bd1c83a2ea224841d22463992be599dfc385 Mon Sep 17 00:00:00 2001
> > From: Brant Gardner <brantcgardner@brantware.com>
> > Date: Tue, 2 Apr 2019 11:09:45 -0500
> > Subject: [PATCH] Added distributed.scm
> >
> > New package file for BOINC and other distributed-computing projects.  This
> > initial file just includes boinc-client and boinc-server, both at version
> > 7.14.2.
> 
> The convention is to write commit logs in ChangeLog format, as
> described at:
> 
>   https://www.gnu.org/prep/standards/html_node/Change-Logs.html
> 
> But you can simply look at git log and mimic what you see.  (You might
> also want to take a look at
> <https://gnu.org/software/guix/manual/en/html_node/Submitting-Patches.html>
> if you havent already.)
> 

Yeah, I was following the guide but I had accidentally already committed before I read the part on commit log format.  I'll make a new one that follows the pattern this time.

> As for the module name, what about boinc.scm instead?  Distributed
> sounds a bit too generic to me.
>

Done :)
 
> > +++ b/gnu/packages/distributed.scm
> > @@ -0,0 +1,119 @@
> > +;;; GNU Guix --- Functional package management for GNU
> > +;;; Copyright .© 2014, 2015 Ludovic Court.¨s <ludo@gnu.org>
> > +;;; Copyright .© 2016, 2017, 2018, 2019 Efraim Flashner <efraim@flashner.co.il>
> > +;;; Copyright .© 2018 Tobias Geerinckx-Rice <me@tobias.gr>
> > +;;; Copyright .© 2018 Mathieu Othacehe <m.othacehe@gmail.com>
> 
> It should be just you here.  :-)
> 

Got it, done.

> > +  #:use-module (gnu packages autotools)
> > +  #:use-module (gnu packages base)
> > +  #:use-module (gnu packages compression)
> > +  #:use-module (gnu packages databases)
> > +  #:use-module (gnu packages pkg-config)
> > +  #:use-module (gnu packages tls)
> > +  #:use-module (gnu packages curl)
> > +  #:use-module (gnu packages wxwidgets)
> > +  #:use-module (gnu packages gnome)
> > +  #:use-module (gnu packages gtk)
> > +  #:use-module (gnu packages perl)
> > +  #:use-module (gnu packages sqlite)
> > +  #:use-module (gnu packages python)
> > +  #:use-module (gnu packages python-xyz))
> 
> I think you can trim this list.
> 

I don't believe so, I arrived at that list via 'build, fail on missing dependency, find it, add it, repeat'.  This was the result - I know it's long and varied but it appears to be correct unless I misunderstand how to properly do dependencies.

> > +    (synopsis "BOINC lets you help cutting-edge science research using your computer")
> 
> What about something like Contribute computing power to research projects?
> 

Sure thing - but to be clear, these aren't my words.  I copied/pasted from the project homepage 'About' section.  I figured they wrote it, they knew how to describe it.

> > +    (description "BOINC is a platform for high-throughput computing on a large
> > +scale (thousands or millions of computers).  It can be used for volunteer
> > +computing (using consumer devices) or grid computing (using organizational
> > +resources).  It supports virtualized, parallel, and GPU-based applications.
> > +
> > +BOINC is distributed under the LGPL open source license.  It can be used for
> > +commercial purposes, and applications need not be open source.")
> 
> This last paragraph is unnecessary: everything in Guix is free software,
> so we never mention it in descriptions.

Got it, done.

> 
> > +    (synopsis "BOINC lets you help cutting-edge science research using your computer")
> > +    (description "BOINC is a platform for high-throughput computing on a large
> > +scale (thousands or millions of computers).  It can be used for volunteer
> > +computing (using consumer devices) or grid computing (using organizational
> > +resources).  It supports virtualized, parallel, and GPU-based applications.
> 
> It would be nice to have a slightly different synopsis and description
> for the server and for the client.
>

Understood, I'll go over it and try to differentiate them a bit.

> Apart from that it LGTM!  Could you double check that guix lint is
> happy and send an updated patch?
> 

Hmm.  I already ran 'guix lint' and did everything it advised except for these:

gnu/packages/boinc.scm:45:12: boinc-client@7.14.2: the source URI should not be an autogenerated tarball
gnu/packages/boinc.scm:80:12: boinc-server@7.14.2: the source URI should not be an autogenerated tarball

I understand what it doesn't like, but not what it wanted me to do instead.  Could you advise?

> Thank you!
> 
> Ludo.
>

--
Brant Gardner

Brant,

Brant Gardner wrote:
> Hmm.  I already ran 'guix lint' and did everything it advised 
> except for these:
>
> gnu/packages/boinc.scm:45:12: boinc-client@7.14.2: the source 
> URI should not be an autogenerated tarball
> gnu/packages/boinc.scm:80:12: boinc-server@7.14.2: the source 
> URI should not be an autogenerated tarball
>
> I understand what it doesn't like, but not what it wanted me to 
> do instead.  Could you advise?

The linter would be tickled downright pink if you'd replace the 
current SOURCE field with something very similar to:

  (source
    (origin
      (method git-fetch)
      (uri (git-reference
            (url "https://github.com/BOINC/boinc.git")
            (commit (string-append "client-" version))))
      (sha256
       (base32 
       "0blahblahqnjxblaaaaahf2l79ybeepityboop7wh9yayhashies"))))

And so for the server as well.  You'll have to replace (guix 
download) with (guix git-download) and update the hash once more.

Thanks for your first of many patches!

T G-R

What's the status on this? I've been using a Nix-managed installation of
BOINC; it would be nice if it were easily available on Guix.

I modified the recipe to use git-fetch and git-reference. Thanks for your
contribution!

On Tue, Aug 6, 2019 at 10:14 PM Brian Leung <bkleung89@gmail.com> wrote:

> What's the status on this? I've been using a Nix-managed installation of
> BOINC; it would be nice if it were easily available on Guix.
>

My pleasure, thanks for closing the loop on this since I was not able!

--
Brant Gardner


On Tue, Sep 24, 2019, at 01:56, Brian Leung wrote:
> I modified the recipe to use git-fetch and git-reference. Thanks for your contribution!
> 
> On Tue, Aug 6, 2019 at 10:14 PM Brian Leung <bkleung89@gmail.com> wrote:
>> What's the status on this? I've been using a Nix-managed installation of BOINC; it would be nice if it were easily available on Guix.