Haddock version during build

Simon Peyton-Jones simonpj at microsoft.com
Wed Jun 4 09:29:58 EDT 2008


Further to Simon's remarks below:

a) Haddock takes a flag telling it where to find its libraries. This is a pain for users, especially since Haddock is now very fussy about which libraries it'll understand.

So we should somehow arrange that you can tell Haddock where to find its libraries at install time, so that users don't need to know.

b) The process Simon described below can be done by steam, so that NDP documentation can be Haddock'd:
        1a. Build GHC stage 1
        1b. Build libraries
        1c. Build GHC stage 2

        2. Download and build Haddock, with GHC stage 2

        3. Use this new Haddock to make the documentation for the libraries
                built in (1b)


Who will do these things?  Haddock 2 is 90% done, but this last 10% is important to make it useful.

Simon

| -----Original Message-----
| From: cvs-libraries-bounces at haskell.org [mailto:cvs-libraries-bounces at haskell.org] On Behalf Of Simon
| Marlow
| Sent: 04 June 2008 14:20
| To: David Waern; Duncan Coutts; cvs-libraries at haskell.org; Manuel M T Chakravarty
| Subject: Re: Haddock version during build
|
| So Simon PJ and I just discussed this, and we have a rough plan.
|
| The basic problem is that in order to build documentation for the libraries
| in a GHC build tree using Haddock 2, we have to build Haddock 2 using the
| stage2 GHC.  There's no alternative, because when running Haddock against
| one of the packages in the build tree, it needs to read the interface files
| for the other packages.
|
| So the rough plan is this: if we need to build documentation during a
| build, then we check out a copy of Haddock into the build tree (it's still
| a separate repository, like the libraries), and we build Haddock after
| stage 2, before generating the documentation.  We don't have to ship this
| Haddock with GHC, it's just a temporary build tool.
|
| Sound reasonable?
|
| Cheers,
|         Simon
|
| _______________________________________________
| Cvs-libraries mailing list
| Cvs-libraries at haskell.org
| http://www.haskell.org/mailman/listinfo/cvs-libraries


More information about the Cvs-libraries mailing list