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)-$$($1_$2_VERSION)_HADDOCK_FILE)" ""
  19 $$($1_PACKAGE)-$$($1_$2_VERSION)_HADDOCK_FILE = $1/$2/doc/html/$$($1_PACKAGE)/$$($1_PACKAGE).haddock
  20 ALL_HADDOCK_FILES += $$($$($1_PACKAGE)-$$($1_$2_VERSION)_HADDOCK_FILE)
  21 else
  22 $$(error Already got a haddock file for $$($1_PACKAGE))
  23 endif
  24
  25 haddock: $$($$($1_PACKAGE)-$$($1_$2_VERSION)_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)-$$($1_$2_VERSION)_HADDOCK_FILE)
  33
  34 $$($1_PACKAGE)-$$($1_$2_VERSION)_HADDOCK_DEPS = $$(foreach n,$$($1_$2_DEPS),$$($$n_HADDOCK_FILE) $$($$n_dist-install_v_LIB))
  35
  36 ifeq "$$(HSCOLOUR_SRCS)" "YES"
  37 $1_$2_HADDOCK_FLAGS += --source-module=src/%{MODULE/./-}.html --source-entity=src/%{MODULE/./-}.html\#%{NAME}
  38 endif
  39
  40 ifneq "$$(BINDIST)" "YES"
  41 $$($$($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 $$$$@)/.
  42 ifeq "$$(HSCOLOUR_SRCS)" "YES"
  43         "$$(GHC_CABAL_INPLACE)" hscolour $2 $1
  44 endif
  45         "$$(TOP)/$$(INPLACE_BIN)/haddock" \
  46           --odir="$1/$2/doc/html/$$($1_PACKAGE)" \
  47           --no-tmp-comp-dir \
  48           --dump-interface=$$($$($1_PACKAGE)-$$($1_$2_VERSION)_HADDOCK_FILE) \
  49           --html \
  50           --title="$$($1_PACKAGE)-$$($1_$2_VERSION)$$(if $$(strip $$($1_$2_SYNOPSIS)),: $$(strip $$($1_$2_SYNOPSIS)),)" \
  51           --prologue="$1/$2/haddock-prologue.txt" \
  52           $$(foreach mod,$$($1_$2_HIDDEN_MODULES),--hide=$$(mod)) \
  53           $$(foreach pkg,$$($1_$2_DEPS),$$(if $$($$(pkg)_HADDOCK_FILE),--read-interface=../$$(pkg)$$(comma)../$$(pkg)/src/%{MODULE/./-}.html\#%{NAME}$$(comma)$$($$(pkg)_HADDOCK_FILE))) \
  54           $$(foreach opt,$$($1_$2_v_ALL_HC_OPTS),--optghc=$$(opt)) \
  55           $$($1_$2_HADDOCK_FLAGS) $$($1_$2_HADDOCK_OPTS) \
  56           $$($1_$2_HS_SRCS) \
  57           $$($1_$2_EXTRA_HADDOCK_SRCS)
  58
  59 # --no-tmp-comp-dir above is important: it saves a few minutes in a
  60 # validate.  This flag lets Haddock use the pre-compiled object files
  61 # for the package rather than rebuilding the modules of the package in
  62 # a temporary directory.  Haddock needs to build the package when it
  63 # uses the Template Haskell or Annotations extensions, for example.
  64
  65 # Make the haddocking depend on the library .a file, to ensure
  66 # that we wait until the library is fully build before we haddock it
  67 $$($$($1_PACKAGE)_HADDOCK_FILE) : $$($1_$2_v_LIB)
  68 endif
  69
  70 endif
  71
  72 endef
  73