[Fedora-haskell-list] Re: Planning for the Haskell Platform ... and documentation

[Bryan O'Sullivan]

There's another wrinkle to this: Haddock docs.

Right now, there's one standard, frozen set of HTML Haddocks in
/usr/share/doc/ghc. We have the ability to generate a new index every
time we install or remove a package, so that the index reflects
whatever is installed. Thus installing gtk2hs would add a pile of
entries to the toplevel index.

This seems *really* appealing to me, and we could add it to the %post
and %preun sections of a package's spec file by editing the top-level
macros file that Jens recently added.

One necessary change would be to install all haddock docs under
/usr/share/doc/ghc, so that we could find all '*.haddock' files when
reindexing, using the find command.

FWIW, this is the approach currently taken by Debian for docs.

[Jens-Ulrik Petersen]

>  Right now, there's one standard, frozen set of HTML Haddocks in
>  /usr/share/doc/ghc. We have the ability to generate a new index every
>  time we install or remove a package, so that the index reflects
>  whatever is installed. Thus installing gtk2hs would add a pile of
>  entries to the toplevel index.
>  
>  This seems *really* appealing to me, and we could add it to the %post
>  and %preun sections of a package's spec file by editing the top-level
>  macros file that Jens recently added. 
What does one have to do to update the index?

>  One necessary change would be to install all haddock docs under
>  /usr/share/doc/ghc, so that we could find all '*.haddock' files when
>  reindexing, using the find command. 
Sounds good to me. :-)

-Jens

[Bryan O'Sullivan]

Pardon my top-posting, I'm on an iPhone tonight. To update the index,  
we simply build a big haddock command line, telling it where to find  
all the existing haddocks. I'll experiment and send out precise details.

On Oct 13, 2008, at 18:48, Jens Petersen <petersen(a)redhat.com&gt; wrote:

> > Right now, there's one standard, frozen set of HTML Haddocks
> in
> > /usr/share/doc/ghc. We have the ability to generate a new index every
> > time we install or remove a package, so that the index reflects
> > whatever is installed. Thus installing gtk2hs would add a pile of
> > entries to the toplevel index.
> >
> > This seems *really* appealing to me, and we could add it to the %post
> > and %preun sections of a package's spec file by editing the top-level
> > macros file that Jens recently added.
>
>  What does one have to do to update the index?
>
> > One necessary change would be to install all haddock docs under
> > /usr/share/doc/ghc, so that we could find all '*.haddock' files when
> > reindexing, using the find command.
>
>  Sounds good to me. :-)
>
>  -Jens

[Yaakov Nemoy]

On Mon, Oct 13, 2008 at 11:12 PM, Bryan O'Sullivan <bos(a)serpentine.com&gt; wrote:
>  Pardon my top-posting, I'm on an iPhone tonight. To update the
> index, we
>  simply build a big haddock command line, telling it where to find all the
>  existing haddocks. I'll experiment and send out precise details. 
I presume we can just shove this in a macro, add it to the guidelines
as a requirement for any package with docs in haddock, and be done
with it?

-Yaakov

[Bryan O'Sullivan]

Exactly.

On Oct 13, 2008, at 21:52, "Yaakov Nemoy" <loupgaroublond(a)gmail.com&gt;  
wrote:

>  On Mon, Oct 13, 2008 at 11:12 PM, Bryan O'Sullivan  
>  <bos(a)serpentine.com&gt; wrote:
> > Pardon my top-posting, I'm on an iPhone tonight. To update the  
> > index, we
> > simply build a big haddock command line, telling it where to find  
> > all the
> > existing haddocks. I'll experiment and send out precise details.
>
>  I presume we can just shove this in a macro, add it to the guidelines
>  as a requirement for any package with docs in haddock, and be done
>  with it?
>
>  -Yaakov