Add a safeguard to Core Lint
[ghc.git] / Makefile
index 3325e88..d788599 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -5,11 +5,38 @@
 # This file is part of the GHC build system.
 #
 # To understand how the build system works and how to modify it, see
-#      http://hackage.haskell.org/trac/ghc/wiki/Building/Architecture
-#      http://hackage.haskell.org/trac/ghc/wiki/Building/Modifying
+#      https://gitlab.haskell.org/ghc/ghc/wikis/building/architecture
+#      https://gitlab.haskell.org/ghc/ghc/wikis/building/modifying
 #
 # -----------------------------------------------------------------------------
 
+# Eliminate use of the built-in implicit rules, and clear out the default list
+# of suffixes for suffix rules. Speeds up make quite a bit. Both are needed
+# for the shortest `make -d` output.
+# Don't set --no-builtin-variables; some rules might stop working if you do
+# (e.g. 'make clean' in testsuite/ currently relies on an implicit $RM).
+MAKEFLAGS += --no-builtin-rules
+.SUFFIXES:
+
+
+# -----------------------------------------------------------------------------
+# Sanitize environment
+
+# See #11530
+export GREP_OPTIONS :=
+
+ifneq "$(filter maintainer-clean distclean clean clean_% help,$(MAKECMDGOALS))" ""
+-include mk/config.mk
+else
+include mk/config.mk
+ifeq "$(ProjectVersion)" ""
+$(error Please run ./configure first)
+endif
+endif
+
+include mk/custom-settings.mk
+
+
 ifeq "$(wildcard distrib/)" ""
 
 # We're in a bindist
@@ -21,31 +48,63 @@ default:
 
 .PHONY: install show
 install show:
-       $(MAKE) -r --no-print-directory -f ghc.mk $@ BINDIST=YES NO_INCLUDE_DEPS=YES
+       $(MAKE) --no-print-directory -f ghc.mk $@ BINDIST=YES NO_INCLUDE_DEPS=YES
+
+# Note [install-strip]
+#
+# install-strip is like install, but it strips the executable files while
+# installing them.
+#
+# From http://www.gnu.org/prep/standards/html_node/Standard-Targets.html:
+#
+#   "install-strip should not strip the executables in the build directory
+#   which are being copied for installation. It should only strip the copies
+#   that are installed. "
+
+.PHONY: install-strip
+install-strip:
+       # See Note [install-strip].
+       $(MAKE) --no-print-directory -f ghc.mk INSTALL_PROGRAM='$(INSTALL_PROGRAM) -s' install BINDIST=YES NO_INCLUDE_DEPS=YES
 
 else
 
+.PHONY: default
 default : all
        @:
 
 # For help, type 'make help'
 .PHONY: help
-help :
-       @cat MAKEHELP
-
-ifneq "$(findstring clean,$(MAKECMDGOALS))" ""
--include mk/config.mk
-else
-include mk/config.mk
-ifeq "$(ProjectVersion)" ""
-$(error Please run ./configure first)
-endif
-endif
-
-include mk/custom-settings.mk
+help:
+       @cat MAKEHELP.md
 
 # No need to update makefiles for these targets:
-REALGOALS=$(filter-out binary-dist binary-dist-prep bootstrapping-files framework-pkg clean clean_% distclean maintainer-clean show help test fulltest,$(MAKECMDGOALS))
+# (the ones we're filtering out)
+REALGOALS=$(filter-out \
+    binary-dist \
+    binary-dist-prep \
+    install-strip \
+    sdist sdist-ghc \
+    sdist-ghc-prep \
+    sdist-windows-tarballs \
+    sdist-windows-tarballs-prep \
+    sdist-testsuite \
+    sdist-testsuite-prep \
+    bootstrapping-files \
+    framework-pkg \
+    clean \
+    clean_% \
+    distclean \
+    maintainer-clean \
+    show \
+    show! \
+    echo \
+    help \
+    test \
+    fulltest \
+    slowtest \
+    fasttest \
+    fast \
+  ,$(MAKECMDGOALS))
 
 # configure touches certain files even if they haven't changed.  This
 # can mean a lot of unnecessary recompilation after a re-configure, so
@@ -58,46 +117,69 @@ REALGOALS=$(filter-out binary-dist binary-dist-prep bootstrapping-files framewor
 
 # NB. not the same as saying '%: ...', which doesn't do the right thing:
 # it does nothing if we specify a target that already exists.
-.PHONY: $(REALGOALS)
+.PHONY: $(REALGOALS) all
 $(REALGOALS) all: mk/config.mk.old mk/project.mk.old compiler/ghc.cabal.old
 ifneq "$(OMIT_PHASE_0)" "YES"
        @echo "===--- building phase 0"
-       $(MAKE) -r --no-print-directory -f ghc.mk phase=0 phase_0_builds
+       $(MAKE) --no-print-directory -f ghc.mk phase=0 phase_0_builds
 endif
 ifneq "$(OMIT_PHASE_1)" "YES"
        @echo "===--- building phase 1"
-       $(MAKE) -r --no-print-directory -f ghc.mk phase=1 phase_1_builds
+       $(MAKE) --no-print-directory -f ghc.mk phase=1 phase_1_builds
 endif
        @echo "===--- building final phase"
-       $(MAKE) -r --no-print-directory -f ghc.mk phase=final $@
+       $(MAKE) --no-print-directory -f ghc.mk phase=final $@
 
+# if BINARY_DIST_DIR is not set, assume we want the old
+# behaviour of placing the binary dist into the current
+# directory. Provide BINARY_DIST_DIR to put the final
+# binary distribution elsewhere.
+BINARY_DIST_DIR ?= .
+
+.PHONY: binary-dist
 binary-dist: binary-dist-prep
-ifeq "$(mingw32_TARGET_OS)" "1"
-       mv bindistprep/*.exe .
-endif
-       mv bindistprep/*.tar.bz2 .
+       mv bindistprep/*.tar.$(TAR_COMP_EXT) "$(BINARY_DIST_DIR)"
 
+.PHONY: binary-dist-prep
 binary-dist-prep:
 ifeq "$(mingw32_TARGET_OS)" "1"
-       $(MAKE) -r --no-print-directory -f ghc.mk windows-binary-dist-prep
-       $(MAKE) -r --no-print-directory -f ghc.mk windows-installer
+       $(MAKE) --no-print-directory -f ghc.mk windows-binary-dist-prep
 else
        rm -f bindist-list
-       $(MAKE) -r --no-print-directory -f ghc.mk bindist BINDIST=YES
-       $(MAKE) -r --no-print-directory -f ghc.mk unix-binary-dist-prep
+       $(MAKE) --no-print-directory -f ghc.mk bindist-list BINDIST=YES
+       $(MAKE) --no-print-directory -f ghc.mk unix-binary-dist-prep
 endif
 
+.PHONY: install-strip
+install-strip:
+       # See Note [install-strip].
+       $(MAKE) --no-print-directory -f ghc.mk INSTALL_PROGRAM='$(INSTALL_PROGRAM) -s' install
+
+.PHONY: sdist sdist-ghc sdist-ghc-prep sdist-windows-tarballs sdist-windows-tarballs-prep sdist-testsuite sdist-testsuite-prep
+# Just running `./boot && ./configure && make sdist` should work, so skip
+# phase 0 and 1 and don't build any dependency files.
+sdist sdist-ghc sdist-ghc-prep sdist-windows-tarballs sdist-windows-tarballs-prep sdist-testsuite sdist-testsuite-prep :
+       $(MAKE) --no-print-directory -f ghc.mk $@ NO_INCLUDE_DEPS=YES NO_INCLUDE_PKGDATA=YES
+
+.PHONY: clean distclean maintainer-clean
 clean distclean maintainer-clean:
-       $(MAKE) -r --no-print-directory -f ghc.mk $@ CLEANING=YES
+       $(MAKE) --no-print-directory -f ghc.mk $@ CLEANING=YES
        test ! -d testsuite || $(MAKE) -C testsuite $@
 
+.PHONY: $(filter clean_%,$(MAKECMDGOALS))
 $(filter clean_%, $(MAKECMDGOALS)) : clean_% :
-       $(MAKE) -r --no-print-directory -f ghc.mk $@ CLEANING=YES
+       $(MAKE) --no-print-directory -f ghc.mk $@ CLEANING=YES
 
-bootstrapping-files show:
-       $(MAKE) -r --no-print-directory -f ghc.mk $@
+.PHONY: bootstrapping-files show echo
+bootstrapping-files show echo:
+       $(MAKE) --no-print-directory -f ghc.mk $@
+
+.PHONY: show!
+show!:
+       $(MAKE) --no-print-directory -f ghc.mk show NO_INCLUDE_PKGDATA=YES
 
 ifeq "$(darwin_TARGET_OS)" "1"
+.PHONY: framework-pkg
 framework-pkg:
        $(MAKE) -C distrib/MacOS $@
 endif
@@ -108,11 +190,44 @@ endif
 
 endif
 
+# Note [validate and testsuite speed]
+#
+# There are 3 different validate and testsuite speed settings:
+# fast, normal and slow.
+#
+#                              how    how   used
+#           cd tests  config.  many   many  by
+# validate  && make   speed=   tests  ways  whom
+# =============================================================================
+# --fast    fast      2        some   1+exs Travis (to stay within time limit)
+# --normal  test      1        all    1+exs Phabricator (slow takes too long?)
+# --slow    slow      0        all    all   Nightly (slow is ok)
+#
+#           accept    1        all    1
+#
+# `--fast` and `--normal` run one default way, as well as any other ways which
+# are explicitly requested by the test using extra_ways().
+#
+# `make accept` should run all tests exactly once. There is no point in
+# accepting a test for multiple ways, since it should produce the same output
+# for all ways.
+#
+# To make sure all .stderr and .stdout files in the testsuite are never
+# out-of-date, it is useful if Phabricator, via a normal `./validate` and `make
+# test`, runs each test at least once.
+.PHONY: fasttest
+fasttest:
+       $(MAKE) -C testsuite/tests CLEANUP=1 SUMMARY_FILE=../../testsuite_summary.txt fast
+
 .PHONY: test
 test:
-       $(MAKE) -C testsuite/tests CLEANUP=1 OUTPUT_SUMMARY=../../testsuite_summary.txt fast
+       $(MAKE) -C testsuite/tests CLEANUP=1 SUMMARY_FILE=../../testsuite_summary.txt
 
-.PHONY: fulltest
-fulltest:
-       $(MAKE) -C testsuite/tests CLEANUP=1 OUTPUT_SUMMARY=../../testsuite_summary.txt
+.PHONY: slowtest fulltest
+slowtest fulltest:
+       $(MAKE) -C testsuite/tests CLEANUP=1 SUMMARY_FILE=../../testsuite_summary.txt slow
 
+.PHONY: fast
+fast:
+       @echo "You can use 'make fast' only from inside a sub-component directory."
+       @exit 1