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, $3 = way
  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 else
  21 $$(error Already got a haddock file for $$($1_PACKAGE))
  22 endif
  23
  24 ifeq "HADDOCK_DOCS" "YES"
  25 $(call all-target,$1_$2_haddock,$$($$($1_PACKAGE)_HADDOCK_FILE))
  26 endif
  27
  28 $$($1_PACKAGE)_HADDOCK_DEPS = $$(foreach n,$$($1_$2_DEP_NAMES),$$($$n_HADDOCK_FILE))
  29
  30 ifeq "$$(HSCOLOUR_SRCS)" "YES"
  31 $1_$2_HADDOCK_FLAGS += --hyperlink-source
  32 endif
  33
  34 $$($$($1_PACKAGE)_HADDOCK_FILE) : $$(MKDIRHIER) $(INPLACE_BIN)/haddock$(exeext) $$(GHC_CABAL_INPLACE) $$($1_$2_HS_SRCS) $$($$($1_PACKAGE)_HADDOCK_DEPS)
  35         $$(MKDIRHIER) $$(dir $$@)
  36         $$(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)
  37
  38 endif
  39
  40 endef
  41