From mboxrd@z Thu Jan  1 00:00:00 1970
From: Federico Beffa <beffa@ieee.org>
Subject: Re: [PATCH 02/24] gnu: Add ghc-paths.
Date: Wed, 8 Apr 2015 13:44:46 +0200
Message-ID: <CAKrPhPNCQ-=AWOgkJqoSdMVYdkpqE84U84tmsbe4f=7q4bcaOA@mail.gmail.com>
References: <CAKrPhPNeoP_Ywx8beVMnrkeXDwBAJqj=gcTwOEZqLN0wq+cjHw@mail.gmail.com>
	<878ue359rz.fsf@gnu.org>
Mime-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: quoted-printable
Return-path: <guix-devel-bounces+gcggd-guix-devel=m.gmane.org@gnu.org>
Received: from eggs.gnu.org ([2001:4830:134:3::10]:33068)
	by lists.gnu.org with esmtp (Exim 4.71)
	(envelope-from <federico.beffa@gmail.com>) id 1YfoPY-0002Y5-UF
	for guix-devel@gnu.org; Wed, 08 Apr 2015 07:44:49 -0400
Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71)
	(envelope-from <federico.beffa@gmail.com>) id 1YfoPX-0007cR-UG
	for guix-devel@gnu.org; Wed, 08 Apr 2015 07:44:48 -0400
In-Reply-To: <878ue359rz.fsf@gnu.org>
List-Id: "Development of GNU Guix and the GNU System distribution."
	<guix-devel.gnu.org>
List-Unsubscribe: <https://lists.gnu.org/mailman/options/guix-devel>,
	<mailto:guix-devel-request@gnu.org?subject=unsubscribe>
List-Archive: <http://lists.gnu.org/archive/html/guix-devel>
List-Post: <mailto:guix-devel@gnu.org>
List-Help: <mailto:guix-devel-request@gnu.org?subject=help>
List-Subscribe: <https://lists.gnu.org/mailman/listinfo/guix-devel>,
	<mailto:guix-devel-request@gnu.org?subject=subscribe>
Errors-To: guix-devel-bounces+gcggd-guix-devel=m.gmane.org@gnu.org
Sender: guix-devel-bounces+gcggd-guix-devel=m.gmane.org@gnu.org
To: =?UTF-8?Q?Ludovic_Court=C3=A8s?= <ludo@gnu.org>
Cc: Guix-devel <guix-devel@gnu.org>

On Wed, Apr 8, 2015 at 10:01 AM, Ludovic Court=C3=A8s <ludo@gnu.org> wrote:
>> +    (synopsis
>> +     "Knowledge of GHC's installation directories")
>> +    (description
>> +     "Knowledge of GHC's installation directories.")
>
> Please expound a little bit.  Otherwise OK.

Thanks for reviewing all of these!

The problem with this and some other libraries is that the library
doesn't have an official home-page (apart from a source repository
which doesn't include anything other than the source). The description
is taken one-to-one from the Cabal file and I don't really know how I
can expand the description.

The Cabal file of some other libraries like, e.g., ghc-network, give
an, IMO, too detailed description (sometimes even with a code
snippet):

...
description:
  This package provides a low-level networking interface.
  .
  In network-2.6 the @Network.URI@ module was split off into its own
  package, network-uri-2.6. If you're using the @Network.URI@ module
  you can automatically get it from the right package by adding this
  to your .cabal file:
  .
  > flag network-uri
  >   description: Get Network.URI from the network-uri package
  >   default: True
  >
  > library
  >   -- ...
  >   if flag(network-uri)
  >     build-depends: network-uri >=3D 2.6, network >=3D 2.6
  >   else
  >     build-depends: network-uri < 2.6, network < 2.6
  .
  That is, get the module from either network < 2.6 or from
  network-uri >=3D 2.6.
...

... and they also only have a source repository with no high level
information. For this reason I did cut the description to the,
sometimes very short, high level piece.

I hope it's fine to keep the concise description for these.

Regards,
Fede