Add a little documentation to the libraries/Makefile

[ghc-hetmet.git] / libraries / Makefile

diff --git a/libraries/Makefile b/libraries/Makefile
index fe89436..7f4c45a 100644 (file)
--- a/libraries/Makefile
+++ b/libraries/Makefile
@@ -1,4 +1,15 @@
 
+# To do a fresh build:
+#
+#   make clean
+#   make boot
+#   make
+#
+# To rebuild a particular library <package>:
+#
+#   make clean.library.<package>
+#   make build.library.<package>
+
 .PHONY: default_target
 
 default_target: build
@@ -73,6 +84,11 @@ CONFIGURE_OPTS += --enable-library-profiling
 CONFIGURE_STAMP_EXTRAS := $(CONFIGURE_STAMP_EXTRAS)-profiling
 endif
 
+ifeq "$(SplitObjs)" "YES"
+CONFIGURE_OPTS += --enable-split-objs
+CONFIGURE_STAMP_EXTRAS := $(CONFIGURE_STAMP_EXTRAS)-splitting
+endif
+
 BOOTSTRAPPING_CABAL = bootstrapping.cabal
 
 .PHONY: subdirs
@@ -105,8 +121,7 @@ ifBuildable/ifBuildable: ifBuildable.hs stamp/$(BOOTSTRAPPING_CABAL)
        -$(RM) -rf ifBuildable
        mkdir ifBuildable
        $(CP) ifBuildable.hs ifBuildable/
-       cd ifBuildable && $(GHC) -Wall --make -i../$(BOOTSTRAPPING_CABAL) \
-                                ifBuildable -o ifBuildable
+       cd ifBuildable && $(GHC) -Wall --make ifBuildable -o ifBuildable
 
 stamp/$(BOOTSTRAPPING_CABAL):
        $(RM) -rf $(BOOTSTRAPPING_CABAL)
@@ -135,25 +150,31 @@ configure: $(foreach SUBDIR,$(SUBDIRS), \
 $(foreach SUBDIR,$(SUBDIRS), \
                  stamp/configure.library.build$(CONFIGURE_STAMP_EXTRAS).$(SUBDIR)): \
 stamp/configure.library.build$(CONFIGURE_STAMP_EXTRAS).%: %/setup/Setup
-       -$(RM) -f stamp/configure.library.*.$*
-       cd $* && setup/Setup configure \
-                            $(CONFIGURE_OPTS) \
-                            --prefix=$(prefix) \
-                            --with-compiler=../../compiler/ghc-inplace$(dot_bat) \
-                            --with-hc-pkg=../../utils/ghc-pkg/ghc-pkg-inplace$(dot_bat) \
-                            --with-hsc2hs=../../utils/hsc2hs/hsc2hs-inplace$(dot_bat) \
-                            --with-ld=$(LD) \
-                            --datasubdir=ghc \
-                            --haddock-args="--use-contents=../index.html --use-index=../doc-index.html" \
-                            --configure-option=--with-cc=$(CC)
-       touch $@
+       -$(RM) -f stamp/configure.library.*.$* $*/unbuildable
+       ( cd $* && setup/Setup configure \
+                  $(CONFIGURE_OPTS) \
+                  --prefix=$(prefix) \
+                  --with-compiler=../../compiler/ghc-inplace$(dot_bat) \
+                  --with-hc-pkg=../../utils/ghc-pkg/ghc-pkg-inplace$(dot_bat) \
+                  --with-hsc2hs=../../utils/hsc2hs/hsc2hs-inplace$(dot_bat) \
+                  --with-ld=$(LD) \
+                  --datasubdir=ghc \
+                  --haddock-args="--use-contents=../index.html \
+                                  --use-index=../doc-index.html" \
+                  $(addprefix --configure-option=,$(CONFIGURE_ARGS)) \
+                  --configure-option=--with-cc=$(CC) ) \
+             && touch $@ || touch $*/unbuildable
+# We don't touch $@ if configure failed as we would prefer to try
+# configuring it next time round, rather than assuming it'll still fail.
+# This is particularly important for corelibs, where failure means the
+# build dies!
 
 $(foreach SUBDIR,$(SUBDIRS),build.library.$(SUBDIR)):\
 build.library.%: stamp/configure.library.build$(CONFIGURE_STAMP_EXTRAS).% \
                  %/setup/Setup
-       cd $* && ../ifBuildable/ifBuildable setup/Setup build \
+       ifBuildable/ifBuildable $* setup/Setup build \
                                        $(addprefix --ghc-option=,$(GhcLibHcOpts))
-       cd $* && ../ifBuildable/ifBuildable setup/Setup register --inplace
+       ifBuildable/ifBuildable $* setup/Setup register --inplace
 
 .PHONY: doc
 
@@ -165,19 +186,21 @@ doc: $(foreach SUBDIR,$(SUBDIRS),doc.library.$(SUBDIR))
 $(foreach SUBDIR,$(SUBDIRS),doc.library.$(SUBDIR)):\
 doc.library.%: stamp/configure.library.build$(CONFIGURE_STAMP_EXTRAS).% \
                %/setup/Setup
-       cd $* && setup/Setup haddock
+       ifBuildable/ifBuildable $* setup/Setup haddock
 
 .PHONY: install install-docs install.library.%
 
 INSTALL_DIR=$(prefix)/share/ghc/doc/html/
 
 install: $(foreach SUBDIR,$(SUBDIRS),install.library.$(SUBDIR))
+ifneq "$(NO_HADDOCK_DOCS)" "YES"
        $(INSTALL_DATA)   index.html doc-index.html                       $(INSTALL_DIR)
        $(INSTALL_SCRIPT) gen_contents_index                                      $(INSTALL_DIR)
        # Hacks:
        $(INSTALL_DATA)   $(prefix)/share/ghc/doc/html/base/*.css $(INSTALL_DIR)
        $(INSTALL_DATA)   $(prefix)/share/ghc/doc/html/base/*.js  $(INSTALL_DIR)
        $(INSTALL_DATA)   $(prefix)/share/ghc/doc/html/base/*.gif $(INSTALL_DIR)
+endif
 
 # Cabal doesn't let us ask to install docs only, so do nothing here
 install-docs:
@@ -189,7 +212,7 @@ install-docs:
 $(foreach SUBDIR,$(SUBDIRS),stamp/configure.library.install.$(SUBDIR)): \
 stamp/configure.library.install.%: %/setup/Setup
        -$(RM) -f stamp/configure.library.*.$*
-       cd $* && ../ifBuildable/ifBuildable setup/Setup configure \
+       ifBuildable/ifBuildable $* setup/Setup configure \
                                            $(CONFIGURE_OPTS) \
                                            --prefix=$(prefix) \
                                            --with-compiler=$(bindir)/ghc \
@@ -199,9 +222,11 @@ stamp/configure.library.install.%: %/setup/Setup
 # We need to reconfigure as we now need to register with the normal ghc-pkg
 $(foreach SUBDIR,$(SUBDIRS),install.library.$(SUBDIR)): \
 install.library.%: stamp/configure.library.install.% %/setup/Setup
-       cd $* && ../ifBuildable/ifBuildable setup/Setup install
+       ifBuildable/ifBuildable $* setup/Setup install
+
+.PHONY: distclean clean clean.library.%
 
-.PHONY: clean clean.library.%
+distclean: clean
 
 clean: $(foreach SUBDIR,$(SUBDIRS),clean.library.$(SUBDIR))
        $(RM) -f stamp/$(BOOTSTRAPPING_CABAL)
@@ -211,7 +236,7 @@ clean: $(foreach SUBDIR,$(SUBDIRS),clean.library.$(SUBDIR))
 
 $(foreach SUBDIR,$(SUBDIRS),clean.library.$(SUBDIR)): \
 clean.library.%:
-       $(RM) -f stamp/configure.library.*.$*
+       $(RM) -f stamp/configure.library.*.$* $*/unbuildable
        -cd $* && setup/Setup clean
        $(RM) -rf $*/setup