[arch-haskell] Creating binary and doc from the same PKGBUILD

Magnus Therning magnus at therning.org
Sat Oct 12 07:35:22 UTC 2013

Don Stewart wrote:
> magnus:
>> Matthew William Cox wrote:
>>> On Thu, Aug 06, 2009 at 12:07:35PM +0100, Magnus Therning wrote:
>>>> I think it'd be worthwhile to provide packages with haddock-generated
>>>> documentation for all haskell packages.  However, I'm not convinced that
>>>> the docs should be packaged with the binary components of the package.
>>> Generally, Arch users expect docs to come with the package as provided by
>>> upstream, and not as some separate package.
>>> Historically Arch stripped docs out of the packages, but that policy was
>>> reversed over a year ago. See the hue and cry over here:
>>> http://www.archlinux.org/pipermail/arch-dev-public/2008-April/005574.html
>> All right.  Then I'll instead try to modify cabal2arch to build docs as well.
>> The one thing that I _really_ want input on is the location of the docs
>> - GHC ships with docs located in /usr/share/doc/ghc/libraries/
>> - In that directory there's also a script (gen_contents_index) that will
>>   rebuild the index of all haddock docs located in subdirectories (it searches
>>   for */*.haddock).
>> So, is that location an acceptable location for docs of other haskell
>> packages?
> If you can come up with a policy-compliant doc patch, I'm happy to
> proceed with that.

I assume that statement indicates that putting haskell-dataenc documentation
in /usr/share/doc/ghc/libraries/dataenc isn't policy compliant?

The only problem is generating the index.  It seems that haddock generates an
index with links like this:

   <A HREF="dataenc/Codec-Binary-Base64Url.html >Codec.Binary.Base64Url</ >

i.e. they are all relative and to subdirectories of the index file itself.
Given that GHC currently puts its docs in /usr/share/doc/ghc/libraries all
other haskell packages will have to either put their docs there too, or, and I
think this is a better solution, put a symbolic link there.

Where can I find the policy document?


Magnus Therning                        (OpenPGP: 0xAB4DFBA4)
magnus@therning.org          Jabber: magnus@therning.org
http://therning.org/magnus         identi.ca|twitter: magthe

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 197 bytes
Desc: OpenPGP digital signature
URL: <http://www.haskell.org/pipermail/arch-haskell/attachments/20131012/1148143e/attachment.sig>

More information about the arch-haskell mailing list