[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH 02/24] gnu: Add ghc-paths.
From: |
Federico Beffa |
Subject: |
Re: [PATCH 02/24] gnu: Add ghc-paths. |
Date: |
Wed, 8 Apr 2015 13:44:46 +0200 |
On Wed, Apr 8, 2015 at 10:01 AM, Ludovic Courtès <address@hidden> 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 >= 2.6, network >= 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 >= 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