Add a link to the GHC API docs from the library haddock index
[ghc-hetmet.git] / libraries / Makefile
index 606d102..20a7678 100644 (file)
 # To add a new library to the tree, do
 #
 #   darcs get http://darcs.haskell.org/packages/foo
-#   [ -e foo/configure.ac ] && ( cd foo && autoreconf )
+#   [ -f foo/configure.ac ] && ( cd foo && autoreconf )
 #   make make.library.foo
 
-.PHONY: default_target show
+.PHONY: default_target
 
 default_target: all
 
-show:
-       @echo '$(VALUE)="$($(VALUE))"'
-
 # make doesn't give us an easy way to get the libraries built in
 # dependency order the first time, but not rebuild base (for example)
 # when we want to rebuild another library later.
@@ -41,15 +38,15 @@ include $(TOP)/mk/cabal-flags.mk
 
 # Any libraries listed here should also be in ../packages
 
-SUBDIRS  = ghc-prim $(INTEGER_LIBRARY) base array packedstring
-SUBDIRS += containers bytestring old-locale old-time filepath directory
+SUBDIRS  = ghc-prim $(INTEGER_LIBRARY) base syb base3-compat array packedstring
+SUBDIRS += containers bytestring old-locale old-time filepath 
 ifeq "$(GhcLibsWithUnix)" "YES"
 SUBDIRS += unix
 endif
 ifeq "$(Windows)" "YES"
 SUBDIRS += $(wildcard Win32)
 endif
-SUBDIRS += process pretty hpc template-haskell editline Cabal random haskell98
+SUBDIRS += directory process pretty hpc template-haskell editline Cabal random haskell98
 
 # Set GhcBootLibs=YES from the command line to work with just the libraries
 # needed to bootstrap GHC.
@@ -68,14 +65,15 @@ SUBDIRS += $(wildcard time)
 SUBDIRS += $(wildcard stm)
 SUBDIRS += $(wildcard xhtml)
 SUBDIRS += $(wildcard parallel)
-SUBDIRS_BUILD += $(wildcard dph/dph-base)
-SUBDIRS_BUILD += $(wildcard dph/dph-prim-interface)
-SUBDIRS_BUILD += $(wildcard dph/dph-prim-seq)
-SUBDIRS_BUILD += $(wildcard dph/dph-prim-par)
-SUBDIRS_BUILD += $(wildcard dph/dph)
+ifneq "$(wildcard dph)" ""
+SUBDIRS += dph/dph-base
+SUBDIRS += dph/dph-prim-interface
+SUBDIRS += dph/dph-prim-seq
+SUBDIRS += dph/dph-prim-par
+SUBDIRS += dph/dph-seq
+SUBDIRS += dph/dph-par
+endif
 endif
-
-SUBDIRS += $(SUBDIRS_BUILD)
 
 # -----------------------------------------------------------------------------
 
@@ -88,37 +86,6 @@ ifeq "$(ghc_ge_609)" "YES"
 GhcLibHcOpts += -fno-warn-deprecated-flags
 endif
 
-ifeq "$(RelocatableBuild)" "YES"
-# On Windows we want to make moveable bindists, but we need to tell
-# ghc-pkg where the haddock docs are. Therefore we completely ignore
-# where the user tells us to put the haddock documentation and put it
-# somewhere whose relative location we know. When installing we need
-# to give Cabal a real path, though.
-iprefix             = $$topdir
-ibindir             = $$topdir
-ilibdir             = $$topdir
-ilibexecdir         = $$topdir
-idynlibdir          = $$topdir
-idatadir            = $$topdir
-idocdir             = $$topdir/doc/libraries/$$pkg
-ihaddockdir         = $$topdir/doc/libraries/$$pkg
-ihtmldir            = $$httptopdir/doc/libraries/$$pkg
-html_installed_root = $(prefix)/doc/libraries
-else
-# On non-Windows we can just give absolute paths all the time, and
-# thus obey the htmldir that we are given.
-iprefix             = $(prefix)
-ibindir             = $(bindir)
-ilibdir             = $(libdir)
-ilibexecdir         = $(libexecdir)
-idynlibdir          = $(dynlibdir)
-idatadir            = $(datadir)
-idocdir             = $(docdir)/libraries/$$pkg
-ihaddockdir         = $(htmldir)/libraries/$$pkg
-ihtmldir            = $(htmldir)/libraries/$$pkg
-html_installed_root = $(htmldir)/libraries
-endif
-
 IFBUILDABLE=ifBuildable/ifBuildable $(FPTOOLS_TOP_ABS)/packages
 
 ifneq "$(DOING_BIN_DIST)" "YES"
@@ -163,11 +130,15 @@ BOOTSTRAPPING_FLAGS = $(CABAL_GHC_FLAGS) -DCABAL_VERSION=$(CABAL_VERSION) -odir
 boot: ifBuildable/ifBuildable cabal-bin bootstrapping.conf
 
 cabal-bin: cabal-bin.hs
-       mkdir $(HERE_ABS)/bootstrapping
+       -mkdir bootstrapping
        $(GHC) $(BOOTSTRAPPING_FLAGS) --make cabal-bin -o cabal-bin
 
 bootstrapping.conf: cabal-bin
        echo "[]" > $@.tmp
+       -cd extensible-exceptions && $(CABAL) clean     --distpref=dist-bootstrapping
+       cd extensible-exceptions && $(CABAL) configure --distpref=dist-bootstrapping --with-compiler=$(GHC) --with-hc-pkg=$(GHC_PKG) --package-db=$(HERE_ABS)/$@.tmp
+       cd extensible-exceptions && $(CABAL) build     --distpref=dist-bootstrapping
+       cd extensible-exceptions && $(CABAL) install   --distpref=dist-bootstrapping --inplace
        -cd filepath && $(CABAL) clean     --distpref=dist-bootstrapping
        cd filepath && $(CABAL) configure --distpref=dist-bootstrapping --with-compiler=$(GHC) --with-hc-pkg=$(GHC_PKG) --package-db=$(HERE_ABS)/$@.tmp
        cd filepath && $(CABAL) build     --distpref=dist-bootstrapping
@@ -196,10 +167,6 @@ endif
 
 all: build
 
-ifeq "$(HADDOCK_DOCS)" "YES"
-all: doc
-endif
-
 .PHONY: rebuild.library.%
 .PHONY: remake.library.%
 
@@ -230,10 +197,18 @@ ALL_CONFIGURE_FLAGS = \
                                      --use-index=../doc-index.html" \
                   $(CONFIGURE_OPTS)
 
+stamp/configure.library.build$(CONFIGURE_STAMP_EXTRAS).dph/dph-par: \
+    dph/dph-par
+
+stamp/configure.library.build$(CONFIGURE_STAMP_EXTRAS).dph/dph-seq: \
+    dph/dph-seq
+
+dph/%:
+       $(MAKE) -C dph $*
+
 $(foreach SUBDIR,$(SUBDIRS), \
                  stamp/configure.library.build$(CONFIGURE_STAMP_EXTRAS).$(SUBDIR)): \
-stamp/configure.library.build$(CONFIGURE_STAMP_EXTRAS).%: cabal-bin \
-                                                          bootstrapping.conf
+stamp/configure.library.build$(CONFIGURE_STAMP_EXTRAS).%: cabal-bin
        -$(RM) -f stamp/configure.library.*.$* $*/unbuildable
        $(MKDIRHIER) `dirname $@`
        ( cd $* && $(CABAL) configure $(ALL_CONFIGURE_FLAGS) ) \
@@ -248,11 +223,9 @@ stamp/configure.library.build$(CONFIGURE_STAMP_EXTRAS).%: cabal-bin \
 # needs to be done.  However, we're careful not to overwrite GNUmakefile
 # if it hasn't changed, so that dependency-generation isn't forced
 # every time.
-# Packages in $(SUBDIRS_BUILD) need to use the build.* rules instead of
-# make.*, so filter them out and use an alternate rule below instead.
-$(foreach SUBDIR,$(filter-out $(SUBDIRS_BUILD),$(SUBDIRS)),make.library.$(SUBDIR)):\
+$(foreach SUBDIR,$(SUBDIRS),make.library.$(SUBDIR)):\
 make.library.%: stamp/configure.library.build$(CONFIGURE_STAMP_EXTRAS).% \
-                cabal-bin ifBuildable/ifBuildable bootstrapping.conf
+                cabal-bin ifBuildable/ifBuildable
        if $(IFBUILDABLE) $*; then \
          cd $* && \
          cmp -s $(MAKEFILE_LOCAL) Makefile.local || cp $(MAKEFILE_LOCAL) .; \
@@ -265,14 +238,10 @@ make.library.%: stamp/configure.library.build$(CONFIGURE_STAMP_EXTRAS).% \
 
 MAKEFILE_LOCAL = $(FPTOOLS_TOP_ABS)/libraries/Makefile.local
 
-# Alternate rule, as described above
-$(foreach SUBDIR,$(SUBDIRS_BUILD),make.library.$(SUBDIR)):\
-make.library.%: build.library.%
-
 # Build the library using 'setup build' (not the default)
 $(foreach SUBDIR,$(SUBDIRS),build.library.$(SUBDIR)):\
 build.library.%: stamp/configure.library.build$(CONFIGURE_STAMP_EXTRAS).% \
-                 cabal-bin ifBuildable/ifBuildable bootstrapping.conf
+                 cabal-bin ifBuildable/ifBuildable
        if $(IFBUILDABLE) $*; then \
          cd $* && \
          $(CABAL) build $(BUILD_FLAGS); \
@@ -283,17 +252,21 @@ build.library.%: stamp/configure.library.build$(CONFIGURE_STAMP_EXTRAS).% \
 
 html: doc
 
-doc: $(foreach SUBDIR,$(SUBDIRS),doc.library.$(SUBDIR))
+# No docs for compat libraries for now.
+DOC_SUBDIRS = $(filter-out %-compat, $(SUBDIRS))
+
+doc: $(foreach SUBDIR,$(DOC_SUBDIRS),doc.library.$(SUBDIR))
        sh gen_contents_index --inplace
 
 # Making hyperlinked source only works if we have hscolour
 ifneq "$(HSCOLOUR)" ""
-CABAL_HADDOCK_FLAGS=--hyperlink-source
+CABAL_HADDOCK_FLAGS += --hyperlink-source
 endif
+CABAL_HADDOCK_FLAGS += --with-haddock=$(FPTOOLS_TOP_ABS)/utils/haddock/install-inplace/bin/haddock
 
-$(foreach SUBDIR,$(SUBDIRS),doc.library.$(SUBDIR)):\
+$(foreach SUBDIR,$(DOC_SUBDIRS),doc.library.$(SUBDIR)):\
 doc.library.%: stamp/configure.library.build$(CONFIGURE_STAMP_EXTRAS).% \
-               cabal-bin ifBuildable/ifBuildable bootstrapping.conf
+               cabal-bin ifBuildable/ifBuildable
        if $(IFBUILDABLE) $*; then \
          cd $* && $(CABAL) haddock --html-location='../$$pkg' \
                                    $(CABAL_HADDOCK_FLAGS); \
@@ -301,11 +274,15 @@ doc.library.%: stamp/configure.library.build$(CONFIGURE_STAMP_EXTRAS).% \
 ifneq "$(HSCOLOUR)" ""
 # We use */src rather than $*/src due to the $(INTEGER_LIBRARY)/integer
 # mismatch
-       if $(IFBUILDABLE) $*; then cp hscolour.css $*/dist/doc/html/*/src/; fi
+# XXX We also need to check that the directory exists, as e.g. dph disables
+# haddock, so the directory doesn't get made. We should remove this once
+# we can always haddock everything.
+       if $(IFBUILDABLE) $* && [ -d $*/dist/doc/html/*/src/ ]; then cp hscolour.css $*/dist/doc/html/*/src/; fi
 endif
 
-.PHONY: distclean clean clean.library.%
+.PHONY: maintainer-clean distclean clean clean.library.%
 
+maintainer-clean: clean
 distclean: clean
 
 clean: $(foreach SUBDIR,$(SUBDIRS),clean.library.$(SUBDIR))
@@ -319,8 +296,12 @@ clean: $(foreach SUBDIR,$(SUBDIRS),clean.library.$(SUBDIR))
        $(RM) -rf ifBuildable
        $(RM) -f libraries.txt index.html doc-index.html doc-index*.html
        $(RM) -f haddock* *.gif
+       $(RM) -rf stamp/*
+ifneq "$(wildcard dph)" ""
+       $(MAKE) -C dph clean
+endif
 
-distclean:
+maintainer-clean distclean:
        $(RM) $(foreach lib, $(SUBDIRS), $(lib)/.depend $(lib)/.depend.bak)
 
 $(foreach SUBDIR,$(SUBDIRS),clean.library.$(SUBDIR)): \
@@ -340,6 +321,7 @@ ifeq "$(HADDOCK_DOCS)" "YES"
        $(INSTALL_DIR)                                                     $(DESTDIR)$(html_installed_root)
        $(INSTALL_DATA)   index.html doc-index*.html                       $(DESTDIR)$(html_installed_root)
        $(INSTALL_SCRIPT) gen_contents_index                               $(DESTDIR)$(html_installed_root)
+       $(INSTALL_DATA)   prologue.txt                                     $(DESTDIR)$(html_installed_root)
        # Hacks:
        $(INSTALL_DATA)   base/dist/doc/html/*/*.css $(DESTDIR)$(html_installed_root)
        $(INSTALL_DATA)   base/dist/doc/html/*/*.js $(DESTDIR)$(html_installed_root)
@@ -364,23 +346,27 @@ $(foreach SUBDIR,$(SUBDIRS),install.library.$(SUBDIR)): \
 install.library.%: ifBuildable/ifBuildable
        if $(IFBUILDABLE) $*; then \
          cd $* && \
-         $(INSTALL_PACKAGE) install '$(DESTDIR)$(bindir)/ghc-pkg' '$(DESTDIR)$(datadir)/package.conf' '$(DESTDIR)' '$(prefix)' '$(iprefix)' '$(ibindir)' '$(ilibdir)' '$(ilibexecdir)' '$(idynlibdir)' '$(idatadir)' '$(idocdir)' '$(ihtmldir)' '$(ihaddockdir)' ; \
+         $(INSTALL_PACKAGE) install '$(GHC_PKG_INSTALL_PROG)' '$(DESTDIR)$(datadir)/package.conf' '$(DESTDIR)' '$(prefix)' '$(iprefix)' '$(ibindir)' '$(ilibdir)' '$(ilibexecdir)' '$(idynlibdir)' '$(idatadir)' '$(idocdir)' '$(ihtmldir)' '$(ihaddockdir)' ; \
        fi
 
 .PHONY: binary-dist binary-dist.library.%
 
 BIN_DIST_LIBDIR=$(BIN_DIST_DIR)/libraries
 
-BINDIST_EXTRAS += ifBuildable/ifBuildable
 binary-dist: $(foreach SUBDIR,$(SUBDIRS),binary-dist.library.$(SUBDIR))
+ifeq "$(WHERE_AM_I)" ""
+       echo "I don't know where I am" >&2
+       exit 1
+endif
        echo $(WHERE_AM_I)/Makefile >> $(BIN_DIST_LIST)
 # XXX This needs to be changed: This ifBuildable is built with the
 # bootstrapping compiler, so isn't OS X friendly. It should be made into
 # a Cabal package if we keep it. However, once we drop extralibs we can
 # probably remove it anyway.
        echo $(WHERE_AM_I)/ifBuildable/ifBuildable >> $(BIN_DIST_LIST)
+       for FILE in dph/dph-prim-interface/interface/*.h dph/dph/LICENSE; do if [ -f $$FILE ]; then echo $(WHERE_AM_I)/$$FILE >> $(BIN_DIST_LIST); fi; done
 ifeq "$(HADDOCK_DOCS)" "YES"
-       for FILE in gen_contents_index index.html doc-index*.html; do echo $(WHERE_AM_I)/$$FILE >> $(BIN_DIST_LIST); done
+       for FILE in gen_contents_index prologue index.html doc-index*.html; do echo $(WHERE_AM_I)/$$FILE >> $(BIN_DIST_LIST); done
 endif
 
 $(foreach SUBDIR,$(SUBDIRS),binary-dist.library.$(SUBDIR)): \