Merge branch 'master' of mac:ghc/git/val32/.
[ghc.git] / rules / haddock.mk
1 # -----------------------------------------------------------------------------
2 #
3 # (c) 2009 The University of Glasgow
4 #
5 # This file is part of the GHC build system.
6 #
7 # To understand how the build system works and how to modify it, see
8 # http://hackage.haskell.org/trac/ghc/wiki/Building/Architecture
9 # http://hackage.haskell.org/trac/ghc/wiki/Building/Modifying
10 #
11 # -----------------------------------------------------------------------------
12
13
14 define haddock # args: $1 = dir, $2 = distdir
15 $(call trace, haddock($1,$2))
16 $(call profStart, haddock($1,$2))
17
18 ifneq "$$($1_$2_DO_HADDOCK)" "NO"
19
20 ifeq "$$($$($1_PACKAGE)-$$($1_$2_VERSION)_HADDOCK_FILE)" ""
21 $$($1_PACKAGE)-$$($1_$2_VERSION)_HADDOCK_FILE = $1/$2/doc/html/$$($1_PACKAGE)/$$($1_PACKAGE).haddock
22 ALL_HADDOCK_FILES += $$($$($1_PACKAGE)-$$($1_$2_VERSION)_HADDOCK_FILE)
23 else
24 $$(error Already got a haddock file for $$($1_PACKAGE))
25 endif
26
27 haddock: html_$1
28
29 ifeq "$$(HADDOCK_DOCS)" "YES"
30 $(call all-target,$1_$2_haddock,html_$1)
31 endif
32
33 .PHONY: html_$1
34 html_$1 : $$($$($1_PACKAGE)-$$($1_$2_VERSION)_HADDOCK_FILE)
35
36 $$($1_PACKAGE)-$$($1_$2_VERSION)_HADDOCK_DEPS = $$(foreach n,$$($1_$2_DEPS),$$($$n_HADDOCK_FILE) $$($$n_dist-install_v_LIB))
37
38 ifeq "$$(HSCOLOUR_SRCS)" "YES"
39 $1_$2_HADDOCK_FLAGS += --source-module=src/%{MODULE/./-}.html --source-entity=src/%{MODULE/./-}.html\#%{NAME}
40 endif
41
42 ifneq "$$(BINDIST)" "YES"
43 $$($$($1_PACKAGE)-$$($1_$2_VERSION)_HADDOCK_FILE) : $$(INPLACE_BIN)/haddock$$(exeext) $$(GHC_CABAL_INPLACE) $$($1_$2_HS_SRCS) $$($$($1_PACKAGE)-$$($1_$2_VERSION)_HADDOCK_DEPS) | $$$$(dir $$$$@)/.
44 ifeq "$$(HSCOLOUR_SRCS)" "YES"
45 "$$(GHC_CABAL_INPLACE)" hscolour $2 $1
46 endif
47 "$$(TOP)/$$(INPLACE_BIN)/haddock" \
48 --odir="$1/$2/doc/html/$$($1_PACKAGE)" \
49 --no-tmp-comp-dir \
50 --dump-interface=$$($$($1_PACKAGE)-$$($1_$2_VERSION)_HADDOCK_FILE) \
51 --html \
52 --hoogle \
53 --title="$$($1_PACKAGE)-$$($1_$2_VERSION)$$(if $$(strip $$($1_$2_SYNOPSIS)),: $$(strip $$($1_$2_SYNOPSIS)),)" \
54 --prologue="$1/$2/haddock-prologue.txt" \
55 $$(foreach mod,$$($1_$2_HIDDEN_MODULES),--hide=$$(mod)) \
56 $$(foreach pkg,$$($1_$2_DEPS),$$(if $$($$(pkg)_HADDOCK_FILE),--read-interface=../$$(pkg)$$(comma)../$$(pkg)/src/%{MODULE/./-}.html\#%{NAME}$$(comma)$$($$(pkg)_HADDOCK_FILE))) \
57 $$(foreach opt,$$($1_$2_v_ALL_HC_OPTS),--optghc=$$(opt)) \
58 $$($1_$2_HADDOCK_FLAGS) $$($1_$2_HADDOCK_OPTS) \
59 $$($1_$2_HS_SRCS) \
60 $$($1_$2_EXTRA_HADDOCK_SRCS)
61
62 # --no-tmp-comp-dir above is important: it saves a few minutes in a
63 # validate. This flag lets Haddock use the pre-compiled object files
64 # for the package rather than rebuilding the modules of the package in
65 # a temporary directory. Haddock needs to build the package when it
66 # uses the Template Haskell or Annotations extensions, for example.
67
68 # Make the haddocking depend on the library .a file, to ensure
69 # that we wait until the library is fully built before we haddock it
70 $$($$($1_PACKAGE)-$$($1_$2_VERSION)_HADDOCK_FILE) : $$($1_$2_v_LIB)
71 endif
72
73 endif
74
75 $(call profEnd, haddock($1,$2))
76 endef
77