[Haskell] Cabal, Haddock, and the location of documentation

Duncan Coutts duncan.coutts at worc.ox.ac.uk
Mon Jul 9 07:19:30 EDT 2007


On Sun, 2007-07-08 at 22:23 +0200, Matthias Kilian wrote:
> On Sun, Jul 08, 2007 at 06:22:43PM +0100, Duncan Coutts wrote:
> > I think it'd be perfectly reasonable to follow the lead of autoconf here
> > and have slightly finer grained control with respect to the kinds of
> > files we're installing. Autoconf distinguishes docs (and various kinds
> > of docs, html, ps, pdf, man etc) from the generic datadir.
> > 
> > So yes, if you want to extend cabal in this direction I'm happy to
> > review patches.
> 
> Ok, I'll give it a try, but it'll take a while (a week or two).
> First I've to get all the OpenBSD ports updated (including horrible
> workarounds for the missing docdir option). Everything else would
> be maintainance hell for me ;-)
> 
> Anyway, what are the requirements/whishes?
> 
> - Just docdir, maybe htmlsubdir or haddocksubdir
> - Or docdir and separate htmldir / haddockdir
> - Something more flexible

The last comment in bug #140 from Ross seems a sensible suggestion.

http://hackage.haskell.org/trac/hackage/ticket/140

        
        haddockPref determines where the documentation is built;
        mkHaddockDir says where it is installed, currently
        $datadir/$datasubdir/doc/html/$pkg, where $datasubdir defaults
        to $pkgid.  That default doesn't seem right in any case.
        Perhaps we want
        
         --docdir (defaulting to $prefix/share/doc on Unix and something else
           on Windows)
        
         --htmlsubdir (defaulting to $pkgid/html)

Duncan



More information about the cabal-devel mailing list