Re: [PATCH 1/3] gnu: Add imlib2.

[ludo@gnu.org (Ludovic Courtès)]

Alex Kost <alezost@gmail.com> skribis:

> Many thanks to Andreas for detailed comments about licenses.
>
> Ludovic Courtès (2014-09-25 16:56 +0400) wrote:
>
>> Alex Kost <alezost@gmail.com> skribis:
>>
>>> +(define-public imlib2
>>
>> [...]
>>
>>> +    (home-page "http://sourceforge.net/projects/enlightenment/")
>>> +    (synopsis
>>> +     "Library for loading, saving, rendering and manipulating image files")
>>
>> s/Library for//
>
> Done.  Is there any convention about that?

Not really.  The one above didn’t fit on the line, so I thought it would
make sense to strip a couple of words.  :-)

We should add a linter making sure the synopsis doesn’t exceed a certain
length, 60 characters, say.

> I'm asking because there are several "types" of synopses:
>
> - Several synopses begin with "Library for" (libuv, fontconfig,
>   lightning, ...)
>
> - Few ones begin with "Library to" (cloog, petsc, ...)
>
> - Some packages have the following synopsis structure:
>
>     <package-name>, a library ...
>
>   Some of them begin with a capital letter (libjpeg, libgpg-error,
>   freetype, ...), and some with a small one (fpill, libogg, libpaper, ...)
>
> - Many synopses end with "library" (libsamplerate, clucene, libgcrypt, ...)

Synopses starting with the package name are definitely frowned upon (we
should add a linter for that.)  The others listed above may or may not
be OK, depending.

> Also (as I'm writing about synopses): is there a convention to begin a
> synopsis with a capital letter?

Yes.  Another linter needed!

> Also there are 2 packages with synopses beginning with an article:
> “pkg-config” and “id3lib”, but it's a lower-case article (perhaps "guix
> lint" should be adjusted for this case).

Yes.

>> Actually this should probably go to (gnu packages image), which is home
>> for all its friends.
>
> OK, initially I wanted to put it there, but then I found that “giflib”
> is in a separate file, so I thought that maybe "image.scm" contains some
> special image libraries.
>
> If “giflib” also should be put in "image.scm", please don't move it
> there before I push these imlib2/giblib commits  :-)

Fine.  :-)

> From 11c8f170a0f3c8f5f4ed4730681224de46745d62 Mon Sep 17 00:00:00 2001
> From: Alex Kost <alezost@gmail.com>
> Date: Thu, 25 Sep 2014 12:27:25 +0400
> Subject: [PATCH 1/3] gnu: Add imlib2.
>
> * gnu/packages/image.scm (imlib2): New variable.

Perfect!

Thanks for tolerating and even encouraging nitpicking.  ;-)

Ludo’.