Bump haddock submodule
[ghc.git] / mk / build.mk.sample
index a31b576..958cea7 100644 (file)
 # A Sample build.mk
 #
 # Uncomment one of the following BuildFlavour settings to get the desired
 # A Sample build.mk
 #
 # Uncomment one of the following BuildFlavour settings to get the desired
-# overall build type, and then tweak the options in the relevant section
-# below.
+# overall build type.
 
 
+# -------- Build profiles -----------------------------------------------------
 # Uncomment one of these to select a build profile below:
 
 # Full build with max optimisation and everything enabled (very slow build)
 #BuildFlavour = perf
 
 # Uncomment one of these to select a build profile below:
 
 # Full build with max optimisation and everything enabled (very slow build)
 #BuildFlavour = perf
 
+# As above but build GHC using the LLVM backend
+#BuildFlavour = perf-llvm
+
+# Perf build configured for a cross-compiler
+#BuildFlavour = perf-cross
+
 # Fast build with optimised libraries, no profiling (RECOMMENDED):
 #BuildFlavour = quick
 
 # Fast build with optimised libraries, no profiling (RECOMMENDED):
 #BuildFlavour = quick
 
+# Fast build with optimised libraries, no profiling, with LLVM:
+#BuildFlavour = quick-llvm
+
+# Fast build configured for a cross compiler
+#BuildFlavour  = quick-cross
+
 # Even faster build.  NOT RECOMMENDED: the libraries will be
 # completely unoptimised, so any code built with this compiler
 # Even faster build.  NOT RECOMMENDED: the libraries will be
 # completely unoptimised, so any code built with this compiler
-# (including stage2) will run very slowly:
+# (including stage2) will run very slowly, and many GHC tests
+# will fail with this profile (see Trac #12141):
 #BuildFlavour = quickest
 
 # Profile the stage2 compiler:
 #BuildFlavour = prof
 
 #BuildFlavour = quickest
 
 # Profile the stage2 compiler:
 #BuildFlavour = prof
 
+# Profile the stage2 compiler (LLVM backend):
+#BuildFlavour = prof-llvm
+
 # A development build, working on the stage 1 compiler:
 #BuildFlavour = devel1
 
 # A development build, working on the stage 2 compiler:
 #BuildFlavour = devel2
 
 # A development build, working on the stage 1 compiler:
 #BuildFlavour = devel1
 
 # A development build, working on the stage 2 compiler:
 #BuildFlavour = devel2
 
-GhcLibWays = v
-
-# -------- 1. A Performance/Distribution build--------------------------------
-
-ifeq "$(BuildFlavour)" "perf"
-
-# perf matches the default settings, repeated here for comparison:
-
-SRC_HC_OPTS     = -O -H64m
-GhcStage1HcOpts = -O -fasm
-GhcStage2HcOpts = -O2 -fasm
-GhcHcOpts       = -Rghc-timing
-GhcLibHcOpts    = -O2
-GhcLibWays     += p
-
-ifeq "$(PlatformSupportsSharedLibs)" "YES"
-GhcLibWays += dyn
-endif
-
-endif
-
-# -------- A Fast build ------------------------------------------------------
+# A build with max optimisation that still builds the stage2 compiler
+# quickly. Compiled code will be the same as with "perf". Programs
+# will compile more slowly.
+#BuildFlavour = bench
 
 
-ifeq "$(BuildFlavour)" "quickest"
+# As above but build GHC using the LLVM backend
+#BuildFlavour = bench-llvm
 
 
-SRC_HC_OPTS        = -H64m -O0 -fasm
-GhcStage1HcOpts    = -O -fasm
-GhcStage2HcOpts    = -O0 -fasm
-GhcLibHcOpts       = -O0 -fasm
-SplitObjs          = NO
-HADDOCK_DOCS       = NO
-BUILD_DOCBOOK_HTML = NO
-BUILD_DOCBOOK_PS   = NO
-BUILD_DOCBOOK_PDF  = NO
+# Bench build configured for a cross-compiler
+#BuildFlavour = bench-cross
 
 
-endif
-
-# -------- A Fast build with optimised libs ----------------------------------
-
-ifeq "$(BuildFlavour)" "quick"
-
-SRC_HC_OPTS        = -H64m -O0 -fasm
-GhcStage1HcOpts    = -O -fasm
-GhcStage2HcOpts    = -O0 -fasm
-GhcLibHcOpts       = -O -fasm
-SplitObjs          = NO
-HADDOCK_DOCS       = NO
-BUILD_DOCBOOK_HTML = NO
-BUILD_DOCBOOK_PS   = NO
-BUILD_DOCBOOK_PDF  = NO
-
-endif
-
-# -------- Profile the stage2 compiler ---------------------------------------
-
-ifeq "$(BuildFlavour)" "prof"
-
-SRC_HC_OPTS        = -H64m -O0 -fasm
-GhcStage1HcOpts    = -O -fasm
-GhcStage2HcOpts    = -O -fasm
-GhcLibHcOpts       = -O -fasm
-
-GhcLibWays         += p
-GhcProfiled        = YES
-
-SplitObjs          = NO
-HADDOCK_DOCS       = NO
-BUILD_DOCBOOK_HTML = NO
-BUILD_DOCBOOK_PS   = NO
-BUILD_DOCBOOK_PDF  = NO
+# Use the same settings as validate.
+#BuildFlavour = validate
 
 
+ifneq "$(BuildFlavour)" ""
+include mk/flavours/$(BuildFlavour).mk
 endif
 
 endif
 
+# -------- Miscellaneous variables --------------------------------------------
 
 
-# -------- A Development build (stage 1) -------------------------------------
+# Set to V = 0 to get prettier build output.
+# Please use V=1 (the default) when reporting GHC bugs.
+#V=0
 
 
-ifeq "$(BuildFlavour)" "devel1"
+# Should all enabled warnings (see mk/warnings.mk) be turned into errors while
+# building stage 2?
+#WERROR=-Werror
 
 
-SRC_HC_OPTS        = -H64m -O -fasm
-GhcLibHcOpts       = -O -dcore-lint
-GhcStage1HcOpts    = -Rghc-timing -O0 -DDEBUG
-GhcStage2HcOpts    = -Rghc-timing -O -fasm
-SplitObjs          = NO
-HADDOCK_DOCS       = NO
-BUILD_DOCBOOK_HTML = NO
-BUILD_DOCBOOK_PS   = NO
-BUILD_DOCBOOK_PDF  = NO
+# After stage 1 and the libraries have been built, you can uncomment this line:
+#stage=2
 
 
-endif
+# Then stage 1 will not be touched by the build system, until
+# you comment the line again.  This is a useful trick for when you're
+# working on stage 2 and want to freeze stage 1 and the libraries for
+# a while.
 
 
-# -------- A Development build (stage 2) -------------------------------------
+# Enable these if you would like DWARF debugging symbols for your libraries.
+# This is necessary, for instance, to get DWARF stack traces out of programs
+# built by the produced compiler. You must also pass --enable-dwarf-unwind to
+# `configure` to enable the runtime system's builtin unwinding support.
+#GhcLibHcOpts += -g3
+#GhcRtsHcOpts += -g3
 
 
-ifeq "$(BuildFlavour)" "devel2"
+# Build the "extra" packages (see ./packages). This enables more tests. See:
+# https://ghc.haskell.org/trac/ghc/wiki/Building/RunningTests/Running#AdditionalPackages
+#BUILD_EXTRA_PKGS=YES
 
 
-SRC_HC_OPTS        = -H64m -O -fasm
-GhcLibHcOpts       = -O -dcore-lint
-GhcStage1HcOpts    = -Rghc-timing -O -fasm
-GhcStage2HcOpts    = -Rghc-timing -O0 -DDEBUG
-SplitObjs          = NO
-HADDOCK_DOCS       = NO
-BUILD_DOCBOOK_HTML = NO
-BUILD_DOCBOOK_PS   = NO
-BUILD_DOCBOOK_PDF  = NO
+# Uncomment the following line to enable building DPH
+#BUILD_DPH=YES
 
 
-endif
+# Uncomment the following to force `integer-gmp` to use the in-tree GMP 6.1.2
+# (other sometimes useful configure-options: `--with-gmp-{includes,libraries}`)
+#libraries/integer-gmp_CONFIGURE_OPTS += --configure-option=--with-intree-gmp
 
 
-# -----------------------------------------------------------------------------
-# Other settings that might be useful
+# Enable pretty hyperlinked sources
+#HADDOCK_DOCS = YES
+#EXTRA_HADDOCK_OPTS += --quickjump --hyperlinked-source
 
 
-# NoFib settings
-NoFibWays =
+# Don't strip debug and other unneeded symbols from libraries and executables.
 STRIP_CMD = :
 STRIP_CMD = :