haddock.mk 2.9 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12
# -----------------------------------------------------------------------------
#
# (c) 2009 The University of Glasgow
#
# This file is part of the GHC build system.
#
# To understand how the build system works and how to modify it, see
#      http://hackage.haskell.org/trac/ghc/wiki/Building/Architecture
#      http://hackage.haskell.org/trac/ghc/wiki/Building/Modifying
#
# -----------------------------------------------------------------------------

Ian Lynagh's avatar
Ian Lynagh committed
13

Simon Marlow's avatar
Simon Marlow committed
14
define haddock  # args: $1 = dir,  $2 = distdir
15
$(call trace, haddock($1,$2))
Ian Lynagh's avatar
Ian Lynagh committed
16 17 18

ifneq "$$($1_$2_DO_HADDOCK)" "NO"

19 20 21
ifeq "$$($$($1_PACKAGE)-$$($1_$2_VERSION)_HADDOCK_FILE)" ""
$$($1_PACKAGE)-$$($1_$2_VERSION)_HADDOCK_FILE = $1/$2/doc/html/$$($1_PACKAGE)/$$($1_PACKAGE).haddock
ALL_HADDOCK_FILES += $$($$($1_PACKAGE)-$$($1_$2_VERSION)_HADDOCK_FILE)
Ian Lynagh's avatar
Ian Lynagh committed
22 23 24 25
else
$$(error Already got a haddock file for $$($1_PACKAGE))
endif

26
haddock: $$($$($1_PACKAGE)-$$($1_$2_VERSION)_HADDOCK_FILE)
27

Ian Lynagh's avatar
Ian Lynagh committed
28
ifeq "$$(HADDOCK_DOCS)" "YES"
29
$(call all-target,$1_$2_haddock,html_$1)
30
endif
Ian Lynagh's avatar
Ian Lynagh committed
31

32
.PHONY: html_$1
33
html_$1 : $$($$($1_PACKAGE)-$$($1_$2_VERSION)_HADDOCK_FILE)
34

35
$$($1_PACKAGE)-$$($1_$2_VERSION)_HADDOCK_DEPS = $$(foreach n,$$($1_$2_DEPS),$$($$n_HADDOCK_FILE) $$($$n_dist-install_v_LIB))
Ian Lynagh's avatar
Ian Lynagh committed
36 37

ifeq "$$(HSCOLOUR_SRCS)" "YES"
38
$1_$2_HADDOCK_FLAGS += --source-module=src/%{MODULE/./-}.html --source-entity=src/%{MODULE/./-}.html\#%{NAME}
Ian Lynagh's avatar
Ian Lynagh committed
39 40
endif

41
ifneq "$$(BINDIST)" "YES"
42
$$($$($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 $$$$@)/.
Simon Marlow's avatar
Simon Marlow committed
43
ifeq "$$(HSCOLOUR_SRCS)" "YES"
44
	"$$(GHC_CABAL_INPLACE)" hscolour $2 $1
Simon Marlow's avatar
Simon Marlow committed
45
endif
46 47
	"$$(TOP)/$$(INPLACE_BIN)/haddock" \
	  --odir="$1/$2/doc/html/$$($1_PACKAGE)" \
48
	  --no-tmp-comp-dir \
49 50 51 52
	  --dump-interface=$$($$($1_PACKAGE)-$$($1_$2_VERSION)_HADDOCK_FILE) \
	  --html \
	  --title="$$($1_PACKAGE)-$$($1_$2_VERSION)$$(if $$(strip $$($1_$2_SYNOPSIS)),: $$(strip $$($1_$2_SYNOPSIS)),)" \
	  --prologue="$1/$2/haddock-prologue.txt" \
53
	  $$(foreach mod,$$($1_$2_HIDDEN_MODULES),--hide=$$(mod)) \
54
	  $$(foreach pkg,$$($1_$2_DEPS),$$(if $$($$(pkg)_HADDOCK_FILE),--read-interface=../$$(pkg)$$(comma)../$$(pkg)/src/%{MODULE/./-}.html\#%{NAME}$$(comma)$$($$(pkg)_HADDOCK_FILE))) \
55 56 57 58
	  $$(foreach opt,$$($1_$2_v_ALL_HC_OPTS),--optghc=$$(opt)) \
	  $$($1_$2_HADDOCK_FLAGS) $$($1_$2_HADDOCK_OPTS) \
	  $$($1_$2_HS_SRCS) \
	  $$($1_$2_EXTRA_HADDOCK_SRCS)
Ian Lynagh's avatar
Ian Lynagh committed
59

60 61 62 63 64 65
# --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.

66 67 68
# Make the haddocking depend on the library .a file, to ensure
# that we wait until the library is fully build before we haddock it
$$($$($1_PACKAGE)_HADDOCK_FILE) : $$($1_$2_v_LIB)
69
endif
70

Ian Lynagh's avatar
Ian Lynagh committed
71 72 73 74
endif

endef