exclude some haddock-related rules during BINDIST
[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
16 ifneq "$$($1_$2_DO_HADDOCK)" "NO"
17
18 ifeq "$$($$($1_PACKAGE)_HADDOCK_FILE)" ""
19 $$($1_PACKAGE)_HADDOCK_FILE = $1/$2/doc/html/$$($1_PACKAGE)/$$($1_PACKAGE).haddock
20 ALL_HADDOCK_FILES += $$($$($1_PACKAGE)_HADDOCK_FILE)
21 else
22 $$(error Already got a haddock file for $$($1_PACKAGE))
23 endif
24
25 haddock: $$($$($1_PACKAGE)_HADDOCK_FILE)
26
27 ifeq "$$(HADDOCK_DOCS)" "YES"
28 $(call all-target,$1_$2_haddock,html_$1)
29 endif
30
31 .PHONY: html_$1
32 html_$1 : $$($$($1_PACKAGE)_HADDOCK_FILE)
33
34 $$($1_PACKAGE)_HADDOCK_DEPS = $$(foreach n,$$($1_$2_DEP_NAMES),$$($$n_HADDOCK_FILE))
35
36 ifeq "$$(HSCOLOUR_SRCS)" "YES"
37 $1_$2_HADDOCK_FLAGS += --hyperlink-source
38 endif
39
40 ifneq "$$(BINDIST)" "YES"
41 $$($$($1_PACKAGE)_HADDOCK_FILE) : $$(INPLACE_BIN)/haddock$$(exeext) $$(GHC_CABAL_INPLACE) $$($1_$2_HS_SRCS) $$($$($1_PACKAGE)_HADDOCK_DEPS) | $$$$(dir $$$$@)/.
42 "$$(GHC_CABAL_INPLACE)" haddock $2 $1 --with-haddock=$$(TOP)/$$(INPLACE_BIN)/haddock --with-ghc=$$(TOP)/$$(INPLACE_BIN)/ghc-stage2 $$($1_$2_HADDOCK_FLAGS) $$($1_$2_HADDOCK_OPTS)
43
44 # Make the haddocking depend on the library .a file, to ensure
45 # that we wait until the library is fully build before we haddock it
46 $$($$($1_PACKAGE)_HADDOCK_FILE) : $$($1_$2_v_LIB)
47 endif
48
49 endif
50
51 endef
52