[GHC] #9772: Building documentation alone is broken

GHC ghc-devs at haskell.org
Thu Jul 30 17:38:22 UTC 2015


#9772: Building documentation alone is broken
-------------------------------------+-------------------------------------
        Reporter:  jstolarek         |                   Owner:
            Type:  bug               |                  Status:  closed
        Priority:  normal            |               Milestone:  7.12.1
       Component:  Build System      |                 Version:  7.9
      Resolution:  invalid           |                Keywords:
Operating System:  Unknown/Multiple  |            Architecture:
 Type of failure:  Building GHC      |  Unknown/Multiple
  failed                             |               Test Case:
      Blocked By:                    |                Blocking:
 Related Tickets:                    |  Differential Revisions:
-------------------------------------+-------------------------------------
Changes (by thomie):

 * status:  new => closed
 * resolution:   => invalid


Comment:

 Replying to [ticket:9772 jstolarek]:
 > At the moment it seems that the only way to build documentation is to
 actually build all of GHC, which is nonsense.

 Not nonsense at all.

 * To build the user's guide, the tool `utils/mkUserGuidePart` is needed,
 which relies on the ghc library.
 * To build the haddock docs, haddock (!) is needed, which also relies on
 the ghc library. Moreover, haddock itself needs to build a module before a
 can generate documentation for it (I don't know the details).

 From `rules/haddock.mk`:
 {{{
  # --no-tmp-comp-dir above is important: it saves a few minutes in a
  # validate.  This flag lets Haddock use the pre-compiled object files
  # for the package rather than rebuilding the modules of the package in
  # a temporary directory.  Haddock needs to build the package when it
  # uses the Template Haskell or Annotations extensions, for example.
 }}}

--
Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/9772#comment:2>
GHC <http://www.haskell.org/ghc/>
The Glasgow Haskell Compiler


More information about the ghc-tickets mailing list