Mark T8089 as unbroken since #7325 is now resolved
[ghc.git] / ghc.mk
1 # -----------------------------------------------------------------------------
2 #
3 # (c) 2009-2013 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://ghc.haskell.org/trac/ghc/wiki/Building/Architecture
9 # http://ghc.haskell.org/trac/ghc/wiki/Building/Modifying
10 #
11 # -----------------------------------------------------------------------------
12
13 # ToDo List.
14 #
15 # * remove old Makefiles, add new stubs for building in subdirs
16 # * docs/Makefile
17 # * docs/storage-mgmt/Makefile
18 # * docs/vh/Makefile
19 # * rts/dotnet/Makefile
20 # * utils/Makefile
21 # * add Makefiles for the rest of the utils/ programs that aren't built
22 # by default (need to exclude them from 'make all' too)
23
24 # Possible cleanups:
25 #
26 # * per-source-file dependencies instead of one .depend file?
27 # * eliminate undefined variables, and use --warn-undefined-variables?
28 # * put outputs from different ways in different subdirs of distdir/build,
29 # then we don't have to use -osuf/-hisuf. We would have to install
30 # them in different places too, so we'd need ghc-pkg support for packages
31 # of different ways.
32 # * make PACKAGES_STAGE1 generated by './configure' or './boot'?
33 # * we should use a directory of package.conf files rather than a single
34 # file for the inplace package database, so that we can express
35 # dependencies more accurately. Otherwise it's possible to get into
36 # a state where the package database is out of date, and the build
37 # system doesn't know.
38
39 # Approximate build order.
40 #
41 # The actual build order is defined by dependencies, and the phase
42 # ordering used to ensure correct ordering of makefile-generation; see
43 # http://ghc.haskell.org/trac/ghc/wiki/Building/Architecture/Idiom/PhaseOrdering
44 #
45 # * With bootstrapping compiler:
46 # o Build utils/ghc-cabal
47 # o Build utils/ghc-pkg
48 # o Build utils/hsc2hs
49 # o Build utils/genprimopcode
50 # o Build utils/deriveConstants
51 # * For each package:
52 # o configure, generate package-data.mk and inplace-pkg-config
53 # o register each package into inplace/lib/package.conf
54 # * build libffi (if not disabled by --with-system-libffi)
55 # * With bootstrapping compiler:
56 # o Build libraries/{filepath,hpc,Cabal}
57 # o Build compiler (stage 1)
58 # * With stage 1 compiler:
59 # o Build libraries/*
60 # o Build rts
61 # o Build utils/* (except haddock)
62 # o Build compiler (stage 2)
63 # * With stage 2 compiler:
64 # o Build utils/haddock
65 # o Build compiler (stage 3) (optional)
66 # * With haddock:
67 # o libraries/*
68 # o compiler
69
70 .PHONY: default all haddock
71
72 # We need second expansion for the way we handle directories, so that
73 # | $$$$(dir $$$$@)/.
74 # expands to the directory of a rule that uses a % pattern.
75 .SECONDEXPANSION:
76
77 default : all
78
79
80 ##################################################
81 # Check that we have a new enough 'make'
82
83 HAVE_EVAL := NO
84 $(eval HAVE_EVAL := YES)
85
86 ifeq "$(HAVE_EVAL)" "NO"
87 $(error Your make does not support eval. You need GNU make >= 3.81)
88 endif
89
90 ifeq "$(abspath /)" ""
91 $(error Your make does not support abspath. You need GNU make >= 3.81)
92 endif
93 ##################################################
94
95 # -----------------------------------------------------------------------------
96 # Catch make if it runs away into an infinite loop
97 ifeq "$(MAKE_RESTARTS)" ""
98 else ifeq "$(MAKE_RESTARTS)" "1"
99 else
100 $(error Make has restarted itself $(MAKE_RESTARTS) times; is there a makefile bug? See http://ghc.haskell.org/trac/ghc/wiki/Building/Troubleshooting#Makehasrestarteditself3timesisthereamakefilebug for details)
101 endif
102
103 # -----------------------------------------------------------------------------
104 # Misc GNU make utils
105
106 nothing=
107 space=$(nothing) $(nothing)
108 comma=,
109
110 # -----------------------------------------------------------------------------
111 # Makefile debugging
112 #
113 # to see the effective value used for a Makefile variable, do
114 # make show VALUE=MY_VALUE
115 #
116
117 show:
118 @echo '$(VALUE)="$($(VALUE))"'
119
120 # echo is used by the nightly builders to query the build system for
121 # information.
122 # Using printf means that we don't get a trailing newline. We escape
123 # backslashes and double quotes in the string to protect them from the
124 # shell, and percent signs to protect them from printf.
125 echo:
126 @printf "$(subst %,%%,$(subst ",\",$(subst \,\\\\,$($(VALUE)))))"
127
128 # -----------------------------------------------------------------------------
129 # Include subsidiary build-system bits
130
131 include mk/tree.mk
132
133 ifneq "$(CLEANING)" "YES"
134 include mk/config.mk
135 ifeq "$(ProjectVersion)" ""
136 $(error Please run ./configure first)
137 endif
138 endif
139
140 include mk/ways.mk
141
142 # (Optional) build-specific configuration
143 include mk/custom-settings.mk
144
145 # The user can reset SRC_HC_OPTS from mk/build.mk. Since we try to append
146 # '-Wall' to it in mk/warnings.mk, we have to include mk/warnings.mk after
147 # mk/custom-settings.mk.
148 include mk/warnings.mk
149
150 # -----------------------------------------------------------------------------
151 # Check for inconsistent settings, after reading mk/build.mk.
152 # Although mk/config.mk should always contain consistent settings (set by
153 # configure), mk/build.mk can contain pretty much anything.
154
155 ifneq "$(CLEANING)" "YES"
156
157 ifeq "$(DYNAMIC_GHC_PROGRAMS)" "YES"
158 ifeq "$(findstring dyn,$(GhcLibWays))" ""
159 $(error dyn is not in $$(GhcLibWays), but $$(DYNAMIC_GHC_PROGRAMS) is YES)
160 endif
161 else
162 ifeq "$(findstring v,$(GhcLibWays))" ""
163 $(error v is not in $$(GhcLibWays), and $$(DYNAMIC_GHC_PROGRAMS) is not YES)
164 endif
165 endif
166
167 ifeq "$(GhcProfiled)" "YES"
168 ifeq "$(findstring p,$(GhcLibWays))" ""
169 $(error p is not in $$(GhcLibWays), and $$(GhcProfiled) is YES)
170 endif
171 endif
172
173 ifeq "$(BUILD_SPHINX_HTML)" "YES"
174 ifeq "$(SPHINXBUILD)" ""
175 $(error BUILD_SPHINX_HTML=YES, but `sphinx-build` was not found. \
176 Create a file `mk/validate.mk` containing `BUILD_SPHINX_HTML=NO` \
177 (when validating), or install `sphinx-build` and rerun `./configure`. \
178 See https://ghc.haskell.org/trac/ghc/wiki/Building/Preparation)
179 endif
180 endif
181
182 ifeq "$(BUILD_SPHINX_PDF)" "YES"
183 ifeq "$(XELATEX)" ""
184 $(error BUILD_SPHINX_PDF=YES, but `xelatex` was not found. \
185 Install `xelatex`, then rerun `./configure`. \
186 See https://ghc.haskell.org/trac/ghc/wiki/Building/Preparation)
187 endif
188 endif
189
190 ifeq "$(HSCOLOUR_SRCS)" "YES"
191 ifeq "$(HSCOLOUR_CMD)" ""
192 $(error HSCOLOUR_SRCS=YES, but HSCOLOUR_CMD is empty. \
193 Run `cabal install hscolour`, then rerun `./configure`. \
194 See https://ghc.haskell.org/trac/ghc/wiki/Building/Preparation)
195 endif
196 endif
197
198 ifeq "$(HADDOCK_DOCS)" "YES"
199 ifneq "$(CrossCompiling) $(Stage1Only)" "NO NO"
200 $(error Can not build haddock docs when CrossCompiling or Stage1Only. \
201 Set HADDOCK_DOCS=NO in your mk/build.mk file. \
202 See Note [No stage2 packages when CrossCompiling or Stage1Only])
203 endif
204 endif
205
206 ifneq "$(BUILD_SPHINX_HTML) $(BUILD_SPHINX_PDF)" "NO NO"
207 # The User's Guide requires mkUserGuidePart, which uses the GHC API.
208 ifneq "$(CrossCompiling) $(Stage1Only)" "NO NO"
209 $(error Can not build User's Guide when CrossCompiling or Stage1Only. \
210 Set BUILD_SPHINX_HTML=NO, BUILD_SPHINX_PDF=NO in your \
211 mk/build.mk file. \
212 See Note [No stage2 packages when CrossCompiling or Stage1Only])
213 endif
214 endif
215
216 endif # CLEANING
217
218 # -----------------------------------------------------------------------------
219
220 ifeq "$(phase)" ""
221 phase = final
222 endif
223
224 # -----------------------------------------------------------------------------
225 # Utility definitions
226
227 include rules/prof.mk
228 include rules/trace.mk
229 include rules/library-path.mk
230 include rules/add-dependency.mk
231 include rules/make-command.mk
232 include rules/pretty_commands.mk
233
234 # -----------------------------------------------------------------------------
235 # Macros for standard targets
236
237 include rules/all-target.mk
238 include rules/clean-target.mk
239
240 # -----------------------------------------------------------------------------
241 # The inplace tree
242
243 $(eval $(call clean-target,root,inplace,inplace/bin inplace/lib))
244
245 # -----------------------------------------------------------------------------
246 # Whether to build dependencies or not
247
248 # When we're just doing 'make clean' or 'make show', then we don't need
249 # to build dependencies.
250
251 ifeq "$(CLEANING)" "YES"
252 NO_INCLUDE_DEPS = YES
253 NO_INCLUDE_PKGDATA = YES
254 endif
255 ifneq "$(findstring bootstrapping-files,$(MAKECMDGOALS))" ""
256 NO_INCLUDE_DEPS = YES
257 NO_INCLUDE_PKGDATA = YES
258 endif
259 ifeq "$(findstring show,$(MAKECMDGOALS))" "show"
260 NO_INCLUDE_DEPS = YES
261 # We want package-data.mk for show
262 endif
263
264 # -----------------------------------------------------------------------------
265 # Ways
266
267 include rules/way-prelims.mk
268
269 $(foreach way,$(ALL_WAYS),\
270 $(eval $(call way-prelims,$(way))))
271
272 ifeq "$(DYNAMIC_GHC_PROGRAMS)" "YES"
273 GHCI_WAY = dyn
274 HADDOCK_WAY = dyn
275 else
276 GHCI_WAY = v
277 HADDOCK_WAY = v
278 endif
279
280 WINDOWS_DYN_PROG_RTS := rts
281 ifeq "$(GhcThreaded)" "YES"
282 WINDOWS_DYN_PROG_RTS := $(WINDOWS_DYN_PROG_RTS)_thr
283 endif
284 ifeq "$(GhcDebugged)" "YES"
285 WINDOWS_DYN_PROG_RTS := $(WINDOWS_DYN_PROG_RTS)_debug
286 endif
287 WINDOWS_DYN_PROG_RTS := $(WINDOWS_DYN_PROG_RTS)_dyn_LIB_FILE
288
289 # -----------------------------------------------------------------------------
290 # Compilation Flags
291
292 include rules/distdir-opts.mk
293 include rules/distdir-way-opts.mk
294
295 # -----------------------------------------------------------------------------
296 # Finding source files and object files
297
298 include rules/hs-sources.mk
299 include rules/c-sources.mk
300 include rules/includes-sources.mk
301 include rules/hs-objs.mk
302 include rules/c-objs.mk
303 include rules/cmm-objs.mk
304
305 # -----------------------------------------------------------------------------
306 # Suffix rules
307
308 # Suffix rules cause "make clean" to fail on Windows (trac #3233)
309 # so we don't make any when cleaning.
310 ifneq "$(CLEANING)" "YES"
311 include rules/hs-suffix-rules-srcdir.mk
312 include rules/hs-suffix-way-rules-srcdir.mk
313 include rules/hs-suffix-way-rules.mk
314 include rules/hi-rule.mk
315 include rules/c-suffix-rules.mk
316 include rules/cmm-suffix-rules.mk
317 endif
318
319 # -----------------------------------------------------------------------------
320 # Building package-data.mk files from .cabal files
321
322 include rules/package-config.mk
323
324 # -----------------------------------------------------------------------------
325 # Building dependencies
326
327 include rules/dependencies.mk
328 include rules/build-dependencies.mk
329 include rules/include-dependencies.mk
330
331 # -----------------------------------------------------------------------------
332 # Build package-data.mk files
333
334 include rules/build-package-data.mk
335
336 # -----------------------------------------------------------------------------
337 # Build and install a program
338
339 include rules/build-prog.mk
340 include rules/shell-wrapper.mk
341
342 # -----------------------------------------------------------------------------
343 # Build a perl script
344
345 include rules/build-perl.mk
346
347 # -----------------------------------------------------------------------------
348 # Build a package
349
350 include rules/build-package.mk
351 include rules/build-package-way.mk
352 include rules/haddock.mk
353 include rules/tags-package.mk
354 include rules/foreachLibrary.mk
355
356 # -----------------------------------------------------------------------------
357 # Registering hand-written package descriptions (used in rts)
358
359 include rules/manual-package-config.mk
360
361 # -----------------------------------------------------------------------------
362 # Docs
363
364 include rules/sphinx.mk
365
366 # -----------------------------------------------------------------------------
367 # Making bindists and sdists
368
369 include rules/bindist.mk
370 include rules/sdist-ghc-file.mk
371
372 # -----------------------------------------------------------------------------
373 # Directories
374
375 # Don't try to delete directories:
376 .PRECIOUS: %/.
377
378 # Create build directories on demand. NB. the | below: this indicates
379 # that $(MKDIRHIER) is an order-only dependency, which means that this
380 # rule fires after building mkdirhier, but we won't try to recreate
381 # directories if mkdirhier changes.
382 %/. : | $(MKDIRHIER)
383 "$(MKDIRHIER)" $@
384
385 # -----------------------------------------------------------------------------
386 # Lax dependencies
387
388 ifeq "$(LAX_DEPENDENCIES)" "YES"
389 LAX_DEPS_FOLLOW = |
390 else
391 LAX_DEPS_FOLLOW =
392 endif
393
394 # This is a bit of a hack. When LAX_DEPS_FOLLOW is | some rules end up
395 # looking like
396 # target: a | b | c
397 # The first | signals the start of the order-only dependencies, but make
398 # treats the second | as a dependency. So we need to tell make how to
399 # build that dependency.
400
401 .PHONY: |
402 | :
403 @:
404
405 # -----------------------------------------------------------------------------
406 # Packages to build
407 # The lists of packages that we *actually* going to build in each stage:
408 #
409 # $(PACKAGES_STAGE0)
410 # $(PACKAGES_STAGE1)
411 # $(PACKAGES_STAGE2)
412 #
413 # Note that we need to add them to these variables in dependency
414 # order, as this is the order that they get configured in.
415
416 ifeq "$(CLEANING)" "YES"
417
418 define addLibraryForCleaning
419 # We just add all packages to both the stage 0 and stage 1 lists.
420 # Stage 2 gets cleaned in the same way as stage 1, so no need to
421 # add it there.
422 PACKAGES_STAGE0 += $1
423 PACKAGES_STAGE1 += $1
424 endef
425 $(eval $(call foreachLibrary,addLibraryForCleaning))
426
427 else # CLEANING
428
429 # Packages that are built by stage0. These packages are dependencies of
430 # programs such as GHC and ghc-pkg, that we do not assume the stage0
431 # compiler already has installed (or up-to-date enough).
432
433 PACKAGES_STAGE0 = binary Cabal/Cabal hpc ghc-boot-th ghc-boot hoopl transformers template-haskell
434 ifeq "$(Windows_Host)" "NO"
435 PACKAGES_STAGE0 += terminfo
436 endif
437
438 PACKAGES_STAGE1 += ghc-prim
439 PACKAGES_STAGE1 += $(INTEGER_LIBRARY)
440 PACKAGES_STAGE1 += base
441 PACKAGES_STAGE1 += filepath
442 PACKAGES_STAGE1 += array
443 PACKAGES_STAGE1 += deepseq
444 PACKAGES_STAGE1 += bytestring
445 PACKAGES_STAGE1 += containers
446
447 ifeq "$(Windows_Target)" "YES"
448 PACKAGES_STAGE1 += Win32
449 endif
450 PACKAGES_STAGE1 += time
451 ifeq "$(Windows_Target)" "NO"
452 PACKAGES_STAGE1 += unix
453 endif
454
455 PACKAGES_STAGE1 += directory
456 PACKAGES_STAGE1 += process
457 PACKAGES_STAGE1 += hpc
458 PACKAGES_STAGE1 += pretty
459 PACKAGES_STAGE1 += binary
460 PACKAGES_STAGE1 += Cabal/Cabal
461 PACKAGES_STAGE1 += ghc-boot-th
462 PACKAGES_STAGE1 += ghc-boot
463 PACKAGES_STAGE1 += template-haskell
464 PACKAGES_STAGE1 += hoopl
465 PACKAGES_STAGE1 += transformers
466 PACKAGES_STAGE1 += compact
467
468 ifeq "$(HADDOCK_DOCS)" "YES"
469 PACKAGES_STAGE1 += xhtml
470 endif
471
472 ifeq "$(Windows_Target)" "NO"
473 PACKAGES_STAGE1 += terminfo
474 endif
475 PACKAGES_STAGE1 += haskeline
476 PACKAGES_STAGE1 += ghci
477
478 # See Note [No stage2 packages when CrossCompiling or Stage1Only].
479 # See Note [Stage1Only vs stage=1] in mk/config.mk.in.
480 ifeq "$(CrossCompiling) $(Stage1Only)" "NO NO"
481 define addExtraPackage
482 ifeq "$2" "-"
483 # Do nothing; this package is already handled above
484 else ifeq "$2" "dph"
485 ifeq "$$(BUILD_DPH) $$(GhcProfiled)" "YES NO"
486 # The DPH packages need TH, which is incompatible with a profiled GHC.
487 PACKAGES_STAGE2 += $1
488 endif
489 else ifeq "$2" "extra"
490 ifeq "$$(BUILD_EXTRA_PKGS)" "YES"
491 PACKAGES_STAGE2 += $1
492 endif
493 else
494 $$(error Unknown package tag: $2)
495 endif
496 endef
497 $(eval $(call foreachLibrary,addExtraPackage))
498 endif
499
500 # We install all packages that we build.
501 INSTALL_PACKAGES := $(addprefix libraries/,$(PACKAGES_STAGE1))
502 # See Note [Stage1Only vs stage=1] in mk/config.mk.in.
503 ifneq "$(Stage1Only)" "YES"
504 INSTALL_PACKAGES += compiler
505 endif
506 INSTALL_PACKAGES += $(addprefix libraries/,$(PACKAGES_STAGE2))
507
508 endif # CLEANING
509
510 # -------------------------------------------
511 # Note [Dependencies between package-data.mk files].
512
513 # We cannot run ghc-cabal to configure a package until we have
514 # configured and registered all of its dependencies. So the following
515 # hack forces all the configure steps to happen in exactly the following order:
516 #
517 # $(PACKAGES_STAGE1) ghc(stage2) $(PACKAGES_STAGE2)
518 #
519 # Ideally we should use the correct dependencies here to allow more
520 # parallelism, but we don't know the dependencies until we've
521 # generated the package-data.mk files.
522 define fixed_pkg_dep
523 libraries/$1/$2/package-data.mk : $$(fixed_pkg_prev)
524 fixed_pkg_prev:=libraries/$1/$2/package-data.mk
525 endef
526
527 ifneq "$(BINDIST)" "YES"
528 fixed_pkg_prev=
529 $(foreach pkg,$(PACKAGES_STAGE1),$(eval $(call fixed_pkg_dep,$(pkg),dist-install)))
530
531 # Intermezzo: utils that we build with the stage1 compiler. They depend on
532 # the stage1 packages, so we have to make sure those packages get configured
533 # and registered before we can start with these. Note that they don't depend on
534 # eachother, so we can configure them in parallel.
535 utils/ghc-cabal/dist-install/package-data.mk: $(fixed_pkg_prev)
536 utils/hpc/dist-install/package-data.mk: $(fixed_pkg_prev)
537 utils/ghc-pkg/dist-install/package-data.mk: $(fixed_pkg_prev)
538 utils/hsc2hs/dist-install/package-data.mk: $(fixed_pkg_prev)
539 utils/compare_sizes/dist-install/package-data.mk: $(fixed_pkg_prev)
540 utils/runghc/dist-install/package-data.mk: $(fixed_pkg_prev)
541 iserv/stage2/package-data.mk: $(fixed_pkg_prev)
542 iserv/stage2_p/package-data.mk: $(fixed_pkg_prev)
543 iserv/stage2_dyn/package-data.mk: $(fixed_pkg_prev)
544
545 # the GHC package doesn't live in libraries/, so we add its dependency manually:
546 compiler/stage2/package-data.mk: $(fixed_pkg_prev)
547
548 # and continue with PACKAGES_STAGE2, which depend on GHC:
549 fixed_pkg_prev:=compiler/stage2/package-data.mk
550 $(foreach pkg,$(PACKAGES_STAGE2),$(eval $(call fixed_pkg_dep,$(pkg),dist-install)))
551
552 ghc/stage1/package-data.mk: compiler/stage1/package-data.mk
553 ghc/stage2/package-data.mk: compiler/stage2/package-data.mk
554
555 # Utils that we build with the stage2 compiler.
556 # They depend on the ghc library and some other libraries, but depending on
557 # the ghc library's package-data.mk is sufficient, as that in turn depends on
558 # all the other libraries' package-data.mk files.
559 utils/haddock/dist/package-data.mk: compiler/stage2/package-data.mk
560 utils/ghctags/dist-install/package-data.mk: compiler/stage2/package-data.mk
561 utils/check-api-annotations/dist-install/package-data.mk: compiler/stage2/package-data.mk
562 utils/check-ppr/dist-install/package-data.mk: compiler/stage2/package-data.mk
563 utils/mkUserGuidePart/dist/package-data.mk: compiler/stage2/package-data.mk
564
565 # add the final package.conf dependency: ghc-prim depends on RTS
566 libraries/ghc-prim/dist-install/package-data.mk : rts/dist/package.conf.inplace
567 endif
568
569 # --------------------------------
570 # Misc package-related settings
571
572 # Run Haddock for the packages that will be installed. We need to handle
573 # compiler specially due to the different dist directory name.
574 $(foreach p,$(INSTALL_PACKAGES),$(eval $p_dist-install_DO_HADDOCK = YES))
575 compiler_stage2_DO_HADDOCK = YES
576
577 BOOT_PKG_CONSTRAINTS := \
578 $(foreach d,$(PACKAGES_STAGE0),\
579 $(foreach p,$(basename $(notdir $(wildcard libraries/$d/*.cabal))),\
580 --constraint "$p == $(shell grep -i "^Version:" libraries/$d/$p.cabal | sed "s/[^0-9.]//g")"))
581
582 # The actual .a and .so/.dll files: needed for dependencies.
583 $(foreach way,$(GhcLibWays),$(eval ALL_STAGE1_$(way)_LIBS = $$(foreach lib,$$(PACKAGES_STAGE1),$$(libraries/$$(lib)_dist-install_$(way)_LIB))))
584
585 ALL_STAGE1_LIBS = $(ALL_STAGE1_v_LIBS)
586
587 ifeq "$(BuildSharedLibs)" "YES"
588 ALL_STAGE1_LIBS += $(foreach lib,$(PACKAGES_STAGE1),$(libraries/$(lib)_dist-install_dyn_LIB))
589 endif
590 BOOT_LIBS = $(foreach lib,$(PACKAGES_STAGE0),$(libraries/$(lib)_dist-boot_v_LIB))
591
592 # ----------------------------------------
593 # Special magic for the ghc-prim package
594
595 # We want the ghc-prim package to include the GHC.Prim module when it
596 # is registered, but not when it is built, because GHC.Prim is not a
597 # real source module, it is built-in to GHC. The old build system did
598 # this using Setup.hs, but we can't do that here, so we have a flag to
599 # enable GHC.Prim in the .cabal file (so that the ghc-prim package
600 # remains compatible with the old build system for the time being).
601 # GHC.Prim module in the ghc-prim package with a flag:
602 #
603 libraries/ghc-prim_CONFIGURE_OPTS += --flag=include-ghc-prim
604
605 # And then we strip it out again before building the package:
606 define libraries/ghc-prim_PACKAGE_MAGIC
607 libraries/ghc-prim_dist-install_MODULES := $$(filter-out GHC.Prim,$$(libraries/ghc-prim_dist-install_MODULES))
608 endef
609
610 PRIMOPS_TXT_STAGE1 = compiler/stage1/build/primops.txt
611
612 libraries/ghc-prim/dist-install/build/GHC/PrimopWrappers.hs : $$(genprimopcode_INPLACE) $(PRIMOPS_TXT_STAGE1) | $$(dir $$@)/.
613 "$(genprimopcode_INPLACE)" --make-haskell-wrappers < $(PRIMOPS_TXT_STAGE1) >$@
614
615 # Required so that Haddock documents the primops.
616 libraries/ghc-prim_dist-install_EXTRA_HADDOCK_SRCS = libraries/ghc-prim/dist-install/build/autogen/GHC/Prim.hs
617
618 # ----------------------------------------
619 # Special magic for the integer package
620
621 ifneq "$(CLEANING)" "YES"
622 ifeq "$(INTEGER_LIBRARY)" "integer-gmp"
623 libraries/base_dist-install_CONFIGURE_OPTS += --flags=integer-gmp
624 else ifeq "$(INTEGER_LIBRARY)" "integer-simple"
625 libraries/base_dist-install_CONFIGURE_OPTS += --flags=integer-simple
626 else
627 $(error Unknown integer library: $(INTEGER_LIBRARY))
628 endif
629 endif
630
631 # -----------------------------------------------------------------------------
632 # Include build instructions from all subdirs
633 BUILD_DIRS += utils/mkdirhier
634 BUILD_DIRS += utils/touchy
635 BUILD_DIRS += utils/unlit
636 BUILD_DIRS += utils/hp2ps
637 BUILD_DIRS += driver/split
638 BUILD_DIRS += utils/genprimopcode
639 BUILD_DIRS += driver
640 BUILD_DIRS += driver/ghci
641 BUILD_DIRS += driver/ghc
642 BUILD_DIRS += driver/haddock
643 BUILD_DIRS += libffi
644 BUILD_DIRS += utils/deriveConstants
645 BUILD_DIRS += includes
646 BUILD_DIRS += rts
647 BUILD_DIRS += bindisttest
648 BUILD_DIRS += utils/genapply
649
650 # When cleaning, don't add any library packages to BUILD_DIRS. We include
651 # ghc.mk files for all BUILD_DIRS, but they don't exist until after running
652 # `./boot`. Running `make clean` before anything else, as well as running
653 # `make maintainer-clean` twice, should work.
654 ifneq "$(CLEANING)" "YES"
655 # These are deliberately in reverse order, so as to ensure that
656 # there is no need to have them in dependency order. That's important
657 # because it's tricky to ensure that they are in dependency order when
658 # cross-compiling, as some packages may only be in PACKAGES_STAGE0
659 # or PACKAGES_STAGE1.
660 BUILD_DIRS += $(patsubst %, libraries/%, $(PACKAGES_STAGE2))
661 BUILD_DIRS += $(patsubst %, libraries/%, $(PACKAGES_STAGE1))
662 BUILD_DIRS += $(patsubst %, libraries/%, $(filter-out $(PACKAGES_STAGE1),$(PACKAGES_STAGE0)))
663 ifeq "$(BUILD_DPH)" "YES"
664 # Note: `$(eval $(call foreachLibrary,addExtraPackage))` above adds the
665 # packages listed in `libraries/dph/ghc-packages` (e.g. dph-base) to
666 # PACKAGES_STAGE2. But not 'libraries/dph' itself (it doesn't have a cabal
667 # file). Since it does have a ghc.mk file, we add it to BUILD_DIRS here.
668 BUILD_DIRS += $(wildcard libraries/dph)
669 endif
670 endif
671
672 BUILD_DIRS += libraries/integer-gmp/gmp
673 BUILD_DIRS += utils/haddock
674 BUILD_DIRS += utils/haddock/doc
675 BUILD_DIRS += compiler
676 BUILD_DIRS += utils/hsc2hs
677 BUILD_DIRS += utils/ghc-pkg
678 BUILD_DIRS += utils/testremove
679 BUILD_DIRS += utils/ghctags
680 BUILD_DIRS += utils/check-api-annotations
681 BUILD_DIRS += utils/check-ppr
682 BUILD_DIRS += utils/dll-split
683 BUILD_DIRS += utils/ghc-cabal
684 BUILD_DIRS += utils/hpc
685 BUILD_DIRS += utils/runghc
686 BUILD_DIRS += ghc
687 BUILD_DIRS += utils/mkUserGuidePart
688 BUILD_DIRS += docs/users_guide
689 BUILD_DIRS += utils/count_lines
690 BUILD_DIRS += utils/compare_sizes
691 BUILD_DIRS += iserv
692
693 # ----------------------------------------------
694 # Actually include the sub-ghc.mk's
695
696 ifeq "$(CLEANING)" "YES"
697 # Don't exclude any BUILD_DIRS when cleaning. When you for example build
698 # haddock once, but later set HADDOCK_DOCS back to NO, then 'make clean'
699 # should still clean the haddock directory.
700 else # CLEANING
701 ifeq "$(BINDIST)" "YES"
702 BUILD_DIRS := $(filter-out utils/mkdirhier,$(BUILD_DIRS))
703 BUILD_DIRS := $(filter-out utils/genprimopcode,$(BUILD_DIRS))
704 BUILD_DIRS := $(filter-out bindisttest,$(BUILD_DIRS))
705 BUILD_DIRS := $(filter-out utils/genapply,$(BUILD_DIRS))
706 BUILD_DIRS := $(filter-out utils/mkUserGuidePart,$(BUILD_DIRS))
707 endif
708 ifeq "$(HADDOCK_DOCS)" "NO"
709 BUILD_DIRS := $(filter-out utils/haddock,$(BUILD_DIRS))
710 BUILD_DIRS := $(filter-out utils/haddock/doc,$(BUILD_DIRS))
711 endif
712 ifeq "$(BUILD_SPHINX_HTML) $(BUILD_SPHINX_PDF)" "NO NO"
713 BUILD_DIRS := $(filter-out docs/users_guide,$(BUILD_DIRS))
714 # Don't to build this little utility if we're not building the User's Guide.
715 BUILD_DIRS := $(filter-out utils/mkUserGuidePart,$(BUILD_DIRS))
716 endif
717 ifeq "$(Windows_Host)" "NO"
718 BUILD_DIRS := $(filter-out utils/touchy,$(BUILD_DIRS))
719 endif
720 ifeq "$(GhcUnregisterised)" "YES"
721 BUILD_DIRS := $(filter-out driver/split,$(BUILD_DIRS))
722 endif
723 ifeq "$(GhcWithInterpreter)" "NO"
724 # runghc is just GHCi in disguise
725 BUILD_DIRS := $(filter-out utils/runghc,$(BUILD_DIRS))
726 endif
727 ifneq "$(INTEGER_LIBRARY)" "integer-gmp"
728 BUILD_DIRS := $(filter-out libraries/integer-gmp/gmp,$(BUILD_DIRS))
729 endif
730 ifneq "$(CrossCompiling) $(Stage1Only)" "NO NO"
731 # See Note [No stage2 packages when CrossCompiling or Stage1Only].
732 # See Note [Stage1Only vs stage=1] in mk/config.mk.in.
733 BUILD_DIRS := $(filter-out utils/ghctags,$(BUILD_DIRS))
734 BUILD_DIRS := $(filter-out utils/check-api-annotations,$(BUILD_DIRS))
735 BUILD_DIRS := $(filter-out utils/check-ppr,$(BUILD_DIRS))
736 endif
737 endif # CLEANING
738
739 include $(patsubst %, %/ghc.mk, $(BUILD_DIRS))
740
741 # A useful pseudo-target (must be after the include above, because it needs
742 # the value of things like $(libraries/base_dist-install_v_LIB).
743 .PHONY: stage1_libs
744 stage1_libs : $(ALL_STAGE1_LIBS)
745
746 # We need this extra dependency when building our own libffi, because
747 # GHCi.FFI.hs #includes ffi.h
748 ifneq "$(UseSystemLibFFI)" "YES"
749 libraries/ghci/dist-install/build/GHCi/FFI.hs : $(libffi_HEADERS)
750 endif
751
752 # ----------------------------------------------
753 # Per-package compiler flags
754 #
755 # If you want to add per-package compiler flags, see `mk/warnings.mk`.
756
757 # Add $(GhcLib(Extra)HcOpts) to all package builds
758 $(foreach pkg,$(PACKAGES_STAGE1) $(PACKAGES_STAGE2),$(eval libraries/$(pkg)_dist-install_HC_OPTS += $$(GhcLibHcOpts)))
759 $(foreach pkg,$(PACKAGES_STAGE1) $(PACKAGES_STAGE2),$(eval libraries/$(pkg)_dist-install_EXTRA_HC_OPTS += $$(GhcLibExtraHcOpts)))
760
761 # Add $(GhcBootLib(Extra)HcOpts) to all stage0 package builds
762 $(foreach pkg,$(PACKAGES_STAGE0),$(eval libraries/$(pkg)_dist-boot_HC_OPTS += $$(GhcBootLibHcOpts)))
763 $(foreach pkg,$(PACKAGES_STAGE0),$(eval libraries/$(pkg)_dist-boot_EXTRA_HC_OPTS += $$(GhcBootLibExtraHcOpts)))
764
765 # -----------------------------------------------------------------------------
766 # Bootstrapping libraries
767
768 # We need to build a few libraries with the installed GHC, since GHC itself
769 # and some of the tools depend on them:
770
771 ifneq "$(BINDIST)" "YES"
772
773 ifneq "$(BOOTSTRAPPING_CONF)" ""
774 ifeq "$(wildcard $(BOOTSTRAPPING_CONF))" ""
775 $(shell "$(GHC_PKG)" init $(BOOTSTRAPPING_CONF))
776 endif
777 endif
778
779 $(eval $(call clean-target,root,bootstrapping_conf,$(BOOTSTRAPPING_CONF)))
780
781 # register the boot packages in strict sequence, because running
782 # multiple ghc-pkgs in parallel doesn't work (registrations may get
783 # lost).
784 fixed_pkg_prev=
785 $(foreach pkg,$(PACKAGES_STAGE0),$(eval $(call fixed_pkg_dep,$(pkg),dist-boot)))
786 # ghc-pkg, unlike other utils that we build with the stage0 compiler (TODO: is
787 # this really true?), depends on several boot packages (e.g. Cabal and
788 # ghc-boot). They need to be configured before ghc-pkg, so we add a
789 # dependency between their package-data.mk files. See also Note
790 # [Dependencies between package-data.mk files].
791 utils/ghc-pkg/dist/package-data.mk: $(fixed_pkg_prev)
792 compiler/stage1/package-data.mk: $(fixed_pkg_prev)
793 endif
794
795 ifneq "$(BINDIST)" "YES"
796 # Make sure we have all the GHCi libs by the time we've built
797 # ghc-stage2. DPH includes a bit of Template Haskell which needs the
798 # GHCi libs, and we don't have a better way to express that dependency.
799 #
800 GHCI_LIBS = $(foreach lib,$(PACKAGES_STAGE1),$(libraries/$(lib)_dist-install_GHCI_LIB)) \
801 $(compiler_stage2_GHCI_LIB)
802
803 ifeq "$(UseArchivesForGhci)" "NO"
804 ghc/stage2/build/tmp/$(ghc_stage2_PROG) : $(GHCI_LIBS)
805 endif
806
807 ifeq "$(UseArchivesForGhci)" "YES"
808 GHCI_lib_way = v
809 else
810 GHCI_lib_way = GHCI
811 endif
812
813 # Deps for TH uses in libraries
814 $(foreach way, $(GhcLibWays),$(eval \
815 libraries/vector/dist-install/build/Data/Vector/Fusion/Stream/Monadic.$($(way)_osuf): \
816 $(libraries/primitive_dist-install_$(GHCI_lib_way)_LIB) \
817 ))
818 endif
819
820 # -----------------------------------------------
821 # Haddock-related bits
822
823 # Build the Haddock contents and index
824 ifeq "$(HADDOCK_DOCS)" "YES"
825 libraries/dist-haddock/index.html: $(haddock_INPLACE) $(ALL_HADDOCK_FILES)
826 cd libraries && sh gen_contents_index --intree
827 ifeq "$(phase)" "final"
828 $(eval $(call all-target,library_doc_index,libraries/dist-haddock/index.html))
829 endif
830 INSTALL_LIBRARY_DOCS += libraries/dist-haddock/*
831 endif
832
833 # -----------------------------------------------------------------------------
834 # Creating a local mingw copy on Windows
835
836 ifeq "$(Windows_Host)" "YES"
837
838 install : install_mingw
839 .PHONY: install_mingw
840 install_mingw : $(INPLACE_MINGW)
841 "$(CP)" -Rp $(INPLACE_MINGW) $(prefix)
842
843 install : install_perl
844 .PHONY: install_perl
845 install_perl : $(INPLACE_PERL)
846 "$(CP)" -Rp $(INPLACE_PERL) $(prefix)
847
848 endif # Windows_Host
849
850 ifneq "$(BINDIST)" "YES"
851 $(ghc-prim-$(libraries/ghc-prim_dist-install_VERSION)_HADDOCK_FILE): \
852 libraries/ghc-prim/dist-install/build/autogen/GHC/Prim.hs
853 endif # BINDIST
854
855 libraries/ghc-prim/dist-install/build/autogen/GHC/Prim.hs: \
856 $(PRIMOPS_TXT_STAGE1) $$(genprimopcode_INPLACE) \
857 | $$(dir $$@)/.
858 "$(genprimopcode_INPLACE)" --make-haskell-source < $< > $@
859
860 .PHONY: tags
861 tags: tags_compiler
862
863 .PHONY: TAGS
864 TAGS: TAGS_compiler
865
866 # -----------------------------------------------------------------------------
867 # Installation
868
869 install: install_libs install_packages install_libexecs \
870 install_bins install_libexec_scripts
871 ifeq "$(HADDOCK_DOCS)" "YES"
872 install: install_docs
873 endif
874
875 define installLibsTo
876 # $1 = libraries to install
877 # $2 = directory to install to
878 #
879 # The .dll case calls STRIP_CMD explicitly, instead of `install -s`, because
880 # on Win64, "install -s" calls a strip that doesn't understand 64bit binaries.
881 # For some reason, this means the DLLs end up non-executable, which means
882 # executables that use them just segfault.
883 $(INSTALL_DIR) $2
884 for i in $1; do \
885 case $$i in \
886 *.a) \
887 $(INSTALL_DATA) $(INSTALL_OPTS) $$i $2; \
888 $(RANLIB_CMD) $2/`basename $$i` ;; \
889 *.dll) \
890 $(INSTALL_PROGRAM) $(INSTALL_OPTS) $$i $2 ; \
891 $(STRIP_CMD) $2/`basename $$i` ;; \
892 *.so) \
893 $(INSTALL_SHLIB) $(INSTALL_OPTS) $$i $2 ;; \
894 *.dylib) \
895 $(INSTALL_SHLIB) $(INSTALL_OPTS) $$i $2;; \
896 *) \
897 $(INSTALL_DATA) $(INSTALL_OPTS) $$i $2; \
898 esac; \
899 done
900 endef
901
902 install_bins: $(INSTALL_BINS) $(INSTALL_SCRIPTS)
903 $(INSTALL_DIR) "$(DESTDIR)$(bindir)"
904 for i in $(INSTALL_BINS); do \
905 $(INSTALL_PROGRAM) $(INSTALL_BIN_OPTS) $$i "$(DESTDIR)$(bindir)" ; \
906 done
907 ifneq "$(INSTALL_SCRIPTS)" ""
908 for i in $(INSTALL_SCRIPTS); do \
909 $(INSTALL_SCRIPT) $(INSTALL_OPTS) $$i "$(DESTDIR)$(bindir)" ; \
910 done
911 endif
912
913 install_libs: $(INSTALL_LIBS)
914 $(call installLibsTo, $(INSTALL_LIBS), "$(DESTDIR)$(ghclibdir)")
915
916 install_libexecs: $(INSTALL_LIBEXECS)
917 ifneq "$(INSTALL_LIBEXECS)" ""
918 $(INSTALL_DIR) "$(DESTDIR)$(ghclibexecdir)/bin"
919 for i in $(INSTALL_LIBEXECS); do \
920 $(INSTALL_PROGRAM) $(INSTALL_BIN_OPTS) $$i "$(DESTDIR)$(ghclibexecdir)/bin"; \
921 done
922 # We rename ghc-stage2, so that the right program name is used in error
923 # messages etc.
924 ifeq "$(Windows_Host)" "NO"
925 "$(MV)" "$(DESTDIR)$(ghclibexecdir)/bin/ghc-stage$(INSTALL_GHC_STAGE)" "$(DESTDIR)$(ghclibexecdir)/bin/ghc"
926 endif
927 endif
928
929 install_libexec_scripts: $(INSTALL_LIBEXEC_SCRIPTS)
930 ifneq "$(INSTALL_LIBEXEC_SCRIPTS)" ""
931 $(INSTALL_DIR) "$(DESTDIR)$(ghclibexecdir)/bin"
932 for i in $(INSTALL_LIBEXEC_SCRIPTS); do \
933 $(INSTALL_SCRIPT) $(INSTALL_OPTS) $$i "$(DESTDIR)$(ghclibexecdir)/bin"; \
934 done
935 endif
936
937 install_docs: $(INSTALL_DOCS)
938 $(INSTALL_DIR) "$(DESTDIR)$(docdir)"
939 ifneq "$(INSTALL_DOCS)" ""
940 for i in $(INSTALL_DOCS); do \
941 $(INSTALL_DOC) $(INSTALL_OPTS) $$i "$(DESTDIR)$(docdir)"; \
942 done
943 endif
944 $(INSTALL_DIR) "$(DESTDIR)$(docdir)/html"
945 $(INSTALL_DOC) $(INSTALL_OPTS) docs/index.html "$(DESTDIR)$(docdir)/html"
946 ifneq "$(INSTALL_LIBRARY_DOCS)" ""
947 $(INSTALL_DIR) "$(DESTDIR)$(docdir)/html/libraries"
948 for i in $(INSTALL_LIBRARY_DOCS); do \
949 $(INSTALL_DOC) $(INSTALL_OPTS) $$i "$(DESTDIR)$(docdir)/html/libraries/"; \
950 done
951 $(INSTALL_DATA) $(INSTALL_OPTS) libraries/prologue.txt "$(DESTDIR)$(docdir)/html/libraries/"
952 $(INSTALL_SCRIPT) $(INSTALL_OPTS) libraries/gen_contents_index "$(DESTDIR)$(docdir)/html/libraries/"
953 endif
954 ifneq "$(INSTALL_HTML_DOC_DIRS)" ""
955 for i in $(INSTALL_HTML_DOC_DIRS); do \
956 $(CP) -Rp $$i "$(DESTDIR)$(docdir)/html"; \
957 done
958 endif
959
960 INSTALLED_PACKAGE_CONF=$(DESTDIR)$(topdir)/package.conf.d
961
962 # Install packages in the right order, so that ghc-pkg doesn't complain.
963 # Also, install ghc-pkg first.
964 ifeq "$(Windows_Host)" "NO"
965 INSTALLED_GHC_REAL=$(DESTDIR)$(ghclibexecdir)/bin/ghc
966 INSTALLED_GHC_PKG_REAL=$(DESTDIR)$(ghclibexecdir)/bin/ghc-pkg
967 else
968 INSTALLED_GHC_REAL=$(DESTDIR)$(bindir)/ghc.exe
969 INSTALLED_GHC_PKG_REAL=$(DESTDIR)$(bindir)/ghc-pkg.exe
970 endif
971
972 # Set the INSTALL_DISTDIR_p for each package; compiler is special
973 $(foreach p,$(filter-out compiler,$(INSTALL_PACKAGES)),\
974 $(eval INSTALL_DISTDIR_$p = dist-install))
975 INSTALL_DISTDIR_compiler = stage2
976
977 # Now we can do the installation
978 install_packages: install_libexecs
979 install_packages: rts/dist/package.conf.install
980 $(INSTALL_DIR) "$(DESTDIR)$(topdir)"
981 $(call removeTrees,"$(INSTALLED_PACKAGE_CONF)")
982 $(INSTALL_DIR) "$(INSTALLED_PACKAGE_CONF)"
983 $(INSTALL_DIR) "$(DESTDIR)$(topdir)/rts"
984 $(call installLibsTo, $(RTS_INSTALL_LIBS), "$(DESTDIR)$(topdir)/rts")
985 $(foreach p, $(INSTALL_PACKAGES), \
986 $(call make-command, \
987 "$(ghc-cabal_INPLACE)" copy \
988 $p $(INSTALL_DISTDIR_$p) \
989 "$(STRIP_CMD)" \
990 '$(DESTDIR)' \
991 '$(prefix)' \
992 '$(ghclibdir)' \
993 '$(docdir)/html/libraries' \
994 '$(GhcLibWays)'))
995 "$(INSTALLED_GHC_PKG_REAL)" --force --global-package-db "$(INSTALLED_PACKAGE_CONF)" update rts/dist/package.conf.install
996 $(foreach p, $(INSTALL_PACKAGES), \
997 $(call make-command, \
998 "$(ghc-cabal_INPLACE)" register \
999 $p $(INSTALL_DISTDIR_$p) \
1000 "$(INSTALLED_GHC_REAL)" \
1001 "$(INSTALLED_GHC_PKG_REAL)" \
1002 "$(DESTDIR)$(topdir)" \
1003 '$(DESTDIR)' \
1004 '$(prefix)' \
1005 '$(ghclibdir)' \
1006 '$(docdir)/html/libraries' \
1007 $(RelocatableBuild)))
1008 # when we install the packages above, ghc-pkg obeys umask when creating
1009 # the package.conf files, but for everything else we specify the
1010 # permissions. We therefore now fix the permissions of package.cache.
1011 # This means "sudo make install" does the right thing even if it runs
1012 # with an 077 umask.
1013 for f in '$(INSTALLED_PACKAGE_CONF)'/*; do $(CREATE_DATA) "$$f"; done
1014
1015 # -----------------------------------------------------------------------------
1016 # Binary distributions
1017
1018 ifneq "$(CLEANING)" "YES"
1019 # This rule seems to hold some files open on Windows which prevents
1020 # cleaning, perhaps due to the $(wildcard).
1021
1022 $(eval $(call bindist-list,.,\
1023 LICENSE \
1024 README \
1025 INSTALL \
1026 configure config.sub config.guess install-sh \
1027 settings.in \
1028 packages \
1029 Makefile \
1030 mk/config.mk.in \
1031 $(INPLACE_BIN)/mkdirhier \
1032 utils/ghc-cabal/dist-install/build/tmp/ghc-cabal \
1033 $(BINDIST_WRAPPERS) \
1034 $(BINDIST_PERL_SOURCES) \
1035 $(BINDIST_LIBS) \
1036 $(BINDIST_HI) \
1037 $(BINDIST_EXTRAS) \
1038 $(includes_H_FILES) \
1039 $(includes_DERIVEDCONSTANTS) \
1040 $(includes_GHCCONSTANTS) \
1041 $(libffi_HEADERS) \
1042 $(INSTALL_LIBEXECS) \
1043 $(INSTALL_LIBEXEC_SCRIPTS) \
1044 $(INSTALL_BINS) \
1045 $(INSTALL_SCRIPTS) \
1046 $(INSTALL_MANPAGES) \
1047 $(INSTALL_DOCS) \
1048 $(INSTALL_LIBRARY_DOCS) \
1049 $(addsuffix /*,$(INSTALL_HTML_DOC_DIRS)) \
1050 docs/index.html \
1051 $(wildcard compiler/stage2/doc) \
1052 $(wildcard libraries/*/dist-install/doc/) \
1053 $(wildcard libraries/*/*/dist-install/doc/) \
1054 $(filter-out settings,$(INSTALL_LIBS)) \
1055 $(RTS_INSTALL_LIBS) \
1056 $(filter-out %/project.mk mk/config.mk %/mk/install.mk,$(MAKEFILE_LIST)) \
1057 mk/project.mk \
1058 mk/install.mk.in \
1059 bindist.mk \
1060 libraries/gen_contents_index \
1061 libraries/prologue.txt \
1062 $(wildcard libraries/dph/LICENSE \
1063 libraries/dph/ghc-packages \
1064 libraries/dph/ghc-packages2 \
1065 libraries/dph/ghc-stage2-package) \
1066 ))
1067 endif
1068 # mk/project.mk gets an absolute path, so we manually include it in
1069 # the bindist with a relative path
1070
1071 BIN_DIST_MK = $(BIN_DIST_PREP_DIR)/bindist.mk
1072
1073 unix-binary-dist-prep:
1074 $(call removeTrees,bindistprep/)
1075 "$(MKDIRHIER)" $(BIN_DIST_PREP_DIR)
1076 set -e; for i in packages LICENSE compiler ghc iserv rts libraries utils docs libffi includes driver mk rules Makefile aclocal.m4 config.sub config.guess install-sh settings.in ghc.mk inplace distrib/configure.ac distrib/README distrib/INSTALL; do ln -s ../../$$i $(BIN_DIST_PREP_DIR)/; done
1077 echo "HADDOCK_DOCS = $(HADDOCK_DOCS)" >> $(BIN_DIST_MK)
1078 echo "BUILD_SPHINX_HTML = $(BUILD_SPHINX_HTML)" >> $(BIN_DIST_MK)
1079 echo "BUILD_SPHINX_PDF = $(BUILD_SPHINX_PDF)" >> $(BIN_DIST_MK)
1080 echo "BUILD_MAN = $(BUILD_MAN)" >> $(BIN_DIST_MK)
1081 echo "override ghc-cabal_INPLACE = utils/ghc-cabal/dist-install/build/tmp/ghc-cabal-bindist" >> $(BIN_DIST_MK)
1082 echo "UseSystemLibFFI = $(UseSystemLibFFI)" >> $(BIN_DIST_MK)
1083 cd $(BIN_DIST_PREP_DIR) && autoreconf
1084 $(call removeFiles,$(BIN_DIST_PREP_TAR))
1085 # h means "follow symlinks", e.g. if aclocal.m4 is a symlink to a source
1086 # tree then we want to include the real file, not a symlink to it
1087 cd bindistprep && "$(TAR_CMD)" hcf - -T ../bindist-list | $(TAR_COMP_CMD) -c > ../$(BIN_DIST_PREP_TAR_COMP)
1088
1089 windows-binary-dist-prep:
1090 $(call removeTrees,bindistprep/)
1091 $(MAKE) prefix=$(TOP)/$(BIN_DIST_PREP_DIR) install
1092 cd bindistprep && "$(TAR_CMD)" cf - $(BIN_DIST_NAME) | $(TAR_COMP_CMD) -c > ../$(BIN_DIST_PREP_TAR_COMP)
1093
1094 # tryTimes tries to run its third argument multiple times, until it
1095 # succeeds. Don't call it directly; call try10Times instead.
1096 # The first and second argument to tryTimes are lists of values.
1097 # The length of the first argument is the number of times we have
1098 # already tried. The length of the second argument is the number more
1099 # times we will try.
1100 tryTimes = $(if $2, \
1101 { echo 'Try $(words x $1): $3' ; $3 ; } || \
1102 $(call tryTimes,x $1,$(wordlist 2,$(words $2),$2),$3), \
1103 )
1104
1105 # Try to run the argument 10 times. If all 10 fail, fail.
1106 try10Times = $(call tryTimes,,x x x x x x x x x x,$1) { echo Failed; false; }
1107
1108 .PHONY: publish-binary-dist
1109 publish-binary-dist:
1110 $(call try10Times,$(PublishCp) $(BIN_DIST_TAR_COMP) $(PublishLocation)/dist)
1111
1112 ifeq "$(mingw32_TARGET_OS)" "1"
1113 DOCDIR_TO_PUBLISH = $(BIN_DIST_INST_DIR)/doc
1114 else
1115 DOCDIR_TO_PUBLISH = $(BIN_DIST_INST_DIR)/share/doc/ghc
1116 endif
1117
1118 .PHONY: publish-docs
1119 publish-docs:
1120 $(call try10Times,$(PublishCp) -r $(DOCDIR_TO_PUBLISH)/* $(PublishLocation)/docs)
1121
1122 # -----------------------------------------------------------------------------
1123 # Source distributions
1124
1125 # Do it like this:
1126 #
1127 # $ ./boot
1128 # $ ./configure
1129 # $ make sdist
1130 #
1131
1132 # A source dist is built from a (partial) build tree, because we
1133 # require some extra files not contained in a git checkout: the
1134 # output from Happy and Alex, for example.
1135 #
1136 # The steps performed by 'make sdist' are as follows:
1137 # - build those extra files
1138 # - create a complete link-tree of the current build tree in /tmp
1139 # - run 'make distclean' on that tree
1140 # - remove a bunch of other files that we know shouldn't be in the dist
1141
1142 #
1143 # Directory in which we're going to build the src dist
1144 #
1145 SRC_DIST_ROOT = sdistprep
1146 SRC_DIST_BASE_NAME = ghc-$(ProjectVersion)
1147
1148 SRC_DIST_GHC_NAME = ghc-$(ProjectVersion)-src
1149 SRC_DIST_GHC_ROOT = $(SRC_DIST_ROOT)/ghc
1150 SRC_DIST_GHC_DIR = $(SRC_DIST_GHC_ROOT)/$(SRC_DIST_BASE_NAME)
1151 SRC_DIST_GHC_TARBALL = $(SRC_DIST_ROOT)/$(SRC_DIST_GHC_NAME).tar.$(TAR_COMP_EXT)
1152
1153 SRC_DIST_WINDOWS_TARBALLS_NAME = ghc-$(ProjectVersion)-windows-extra-src
1154 SRC_DIST_WINDOWS_TARBALLS_ROOT = $(SRC_DIST_ROOT)/windows-tarballs
1155 SRC_DIST_WINDOWS_TARBALLS_DIR = $(SRC_DIST_WINDOWS_TARBALLS_ROOT)/$(SRC_DIST_BASE_NAME)
1156 SRC_DIST_WINDOWS_TARBALLS_TARBALL = $(SRC_DIST_ROOT)/$(SRC_DIST_WINDOWS_TARBALLS_NAME).tar.$(TAR_COMP_EXT)
1157
1158 SRC_DIST_TESTSUITE_NAME = ghc-$(ProjectVersion)-testsuite
1159 SRC_DIST_TESTSUITE_ROOT = $(SRC_DIST_ROOT)/testsuite-ghc
1160 SRC_DIST_TESTSUITE_DIR = $(SRC_DIST_TESTSUITE_ROOT)/$(SRC_DIST_BASE_NAME)
1161 SRC_DIST_TESTSUITE_TARBALL = $(SRC_DIST_ROOT)/$(SRC_DIST_TESTSUITE_NAME).tar.$(TAR_COMP_EXT)
1162
1163 #
1164 # Files to include in source distributions
1165 #
1166 SRC_DIST_GHC_DIRS = mk rules docs distrib bindisttest libffi includes \
1167 utils docs rts compiler ghc driver libraries libffi-tarballs iserv
1168 SRC_DIST_GHC_FILES += \
1169 configure.ac config.guess config.sub configure \
1170 aclocal.m4 README.md ANNOUNCE HACKING.md INSTALL.md LICENSE Makefile \
1171 install-sh settings.in VERSION GIT_COMMIT_ID \
1172 boot packages ghc.mk MAKEHELP.md
1173
1174 .PHONY: VERSION
1175 VERSION:
1176 @if test -f $@ && test "`cat $@`" = "$(ProjectVersion)"; \
1177 then echo "$@ needs no update"; \
1178 else echo "update $@ ($(ProjectVersion))"; echo "$(ProjectVersion)" > $@; fi
1179
1180 .PHONY: GIT_COMMIT_ID
1181 GIT_COMMIT_ID:
1182 @if test -d .git && test "`git rev-parse HEAD`" != "$(ProjectGitCommitId)"; then \
1183 echo "******************************************************************************"; \
1184 echo "Stale ProjectGitCommitId (=$(ProjectGitCommitId)) detected!"; \
1185 echo "'git rev-parse HEAD' says: `git rev-parse HEAD`"; \
1186 echo "Please re-run './configure' before creating source-distribution"; \
1187 echo "******************************************************************************"; \
1188 exit 1; \
1189 fi
1190 @if test -f $@ && test "`cat $@`" = "$(ProjectGitCommitId)"; \
1191 then echo "$@ needs no update"; \
1192 else echo "update $@ ($(ProjectGitCommitId))"; echo -n "$(ProjectGitCommitId)" > $@; fi
1193
1194 sdist-ghc-prep-tree : VERSION GIT_COMMIT_ID
1195
1196 # Extra packages which shouldn't be in the source distribution: see #8801
1197 EXTRA_PACKAGES=parallel stm random primitive vector dph
1198
1199 .PHONY: sdist-ghc-prep-tree
1200 sdist-ghc-prep-tree :
1201 $(call removeTrees,$(SRC_DIST_GHC_ROOT))
1202 $(call removeFiles,$(SRC_DIST_GHC_TARBALL))
1203 mkdir -p $(SRC_DIST_ROOT)
1204 mkdir -p $(SRC_DIST_GHC_ROOT)
1205 mkdir -p $(SRC_DIST_GHC_DIR)
1206 cd $(SRC_DIST_GHC_DIR) && for i in $(SRC_DIST_GHC_DIRS); do mkdir -p $$i; ( cd $$i && lndir $(TOP)/$$i ); done
1207 cd $(SRC_DIST_GHC_DIR) && for i in $(SRC_DIST_GHC_FILES); do $(LN_S) $(TOP)/$$i .; done
1208 cd $(SRC_DIST_GHC_DIR) && $(MAKE) distclean
1209 $(call removeTrees,$(SRC_DIST_GHC_DIR)/libraries/tarballs/)
1210 $(call removeTrees,$(SRC_DIST_GHC_DIR)/libraries/stamp/)
1211 $(call removeTrees,$(SRC_DIST_GHC_DIR)/compiler/stage[123])
1212 $(call removeFiles,$(SRC_DIST_GHC_DIR)/mk/build.mk)
1213 for i in $(EXTRA_PACKAGES); do $(RM) $(RM_OPTS_REC) $(SRC_DIST_GHC_DIR)/libraries/$$i/; done
1214 cd $(SRC_DIST_GHC_DIR) && "$(FIND)" $(SRC_DIST_GHC_DIRS) \( -name .git -o -name "autom4te*" -o -name "*~" -o -name "\#*" -o -name ".\#*" -o -name "log" -o -name "*-SAVE" -o -name "*.orig" -o -name "*.rej" \) -print | "$(XARGS)" $(XARGS_OPTS) "$(RM)" $(RM_OPTS_REC)
1215
1216 # Add files generated by alex and happy.
1217 # These rules depend on sdist-ghc-prep-tree.
1218 $(eval $(call sdist-ghc-file,compiler,stage2,cmm,CmmLex,x))
1219 $(eval $(call sdist-ghc-file,compiler,stage2,cmm,CmmParse,y))
1220 $(eval $(call sdist-ghc-file,compiler,stage2,parser,Lexer,x))
1221 $(eval $(call sdist-ghc-file,compiler,stage2,parser,Parser,y))
1222 $(eval $(call sdist-ghc-file,utils/hpc,dist-install,,HpcParser,y))
1223 $(eval $(call sdist-ghc-file,utils/genprimopcode,dist,,Lexer,x))
1224 $(eval $(call sdist-ghc-file,utils/genprimopcode,dist,,Parser,y))
1225
1226 .PHONY: sdist-ghc-prep
1227 sdist-ghc-prep : sdist-ghc-prep-tree
1228
1229 .PHONY: sdist-windows-tarballs-prep
1230 sdist-windows-tarballs-prep :
1231 $(call removeTrees,$(SRC_DIST_WINDOWS_TARBALLS_ROOT))
1232 $(call removeFiles,$(SRC_DIST_WINDOWS_TARBALLS_TARBALL))
1233 mkdir -p $(SRC_DIST_ROOT)
1234 mkdir -p $(SRC_DIST_WINDOWS_TARBALLS_ROOT)
1235 mkdir -p $(SRC_DIST_WINDOWS_TARBALLS_DIR)
1236 mkdir -p $(SRC_DIST_WINDOWS_TARBALLS_DIR)/ghc-tarballs
1237 cd $(SRC_DIST_WINDOWS_TARBALLS_DIR)/ghc-tarballs && lndir $(TOP)/ghc-tarballs
1238 $(call removeTrees,$(SRC_DIST_WINDOWS_TARBALLS_DIR)/ghc-tarballs/.git)
1239
1240 .PHONY: sdist-testsuite-prep
1241 sdist-testsuite-prep :
1242 $(call removeTrees,$(SRC_DIST_TESTSUITE_ROOT))
1243 $(call removeFiles,$(SRC_DIST_TESTSUITE_TARBALL))
1244 mkdir -p $(SRC_DIST_ROOT)
1245 mkdir -p $(SRC_DIST_TESTSUITE_ROOT)
1246 mkdir -p $(SRC_DIST_TESTSUITE_DIR)
1247 mkdir -p $(SRC_DIST_TESTSUITE_DIR)/testsuite
1248 cd $(SRC_DIST_TESTSUITE_DIR)/testsuite && lndir $(TOP)/testsuite
1249 cd $(SRC_DIST_TESTSUITE_DIR)/testsuite && $(MAKE) distclean
1250
1251 .PHONY: sdist-ghc
1252 sdist-ghc: sdist-ghc-prep
1253 cd $(SRC_DIST_GHC_ROOT) && "$(TAR_CMD)" chf - $(SRC_DIST_BASE_NAME) 2> src_ghc_log | $(TAR_COMP_CMD) -c > $(TOP)/$(SRC_DIST_GHC_TARBALL)
1254
1255 .PHONY: sdist-windows-tarballs
1256 sdist-windows-tarballs: sdist-windows-tarballs-prep
1257 cd $(SRC_DIST_WINDOWS_TARBALLS_ROOT) && "$(TAR_CMD)" chf - $(SRC_DIST_BASE_NAME) 2> windows_extra_src_ghc_log | $(TAR_COMP_CMD) -c > $(TOP)/$(SRC_DIST_WINDOWS_TARBALLS_TARBALL)
1258
1259 .PHONY: sdist-testsuite
1260 sdist-testsuite: sdist-testsuite-prep
1261 cd $(SRC_DIST_TESTSUITE_ROOT) && "$(TAR_CMD)" chf - $(SRC_DIST_BASE_NAME) 2> testsuite_log | $(TAR_COMP_CMD) -c > $(TOP)/$(SRC_DIST_TESTSUITE_TARBALL)
1262
1263
1264 .PHONY: sdist
1265 sdist : sdist-ghc sdist-windows-tarballs sdist-testsuite
1266
1267 sdist-manifest : $(SRC_DIST_GHC_TARBALL)
1268 tar tjf $(SRC_DIST_GHC_TARBALL) | sed "s|^ghc-$(ProjectVersion)/||" | sort >sdist-manifest
1269
1270 # Upload the distribution(s)
1271 # Retrying is to work around buggy firewalls that corrupt large file transfers
1272 # over SSH.
1273 ifneq "$(PublishLocation)" ""
1274 publish-sdist :
1275 $(call try10Times,$(PublishCp) $(SRC_DIST_GHC_TARBALL) $(PublishLocation)/dist)
1276 $(call try10Times,$(PublishCp) $(SRC_DIST_TESTSUITE_TARBALL) $(PublishLocation)/dist)
1277 endif
1278
1279 # -----------------------------------------------------------------------------
1280 # sdisting libraries
1281
1282 # Use manually, with e.g.:
1283 # make sdist_directory
1284
1285 sdist_%:
1286 inplace/bin/ghc-cabal sdist libraries/$* dist-install
1287
1288 # -----------------------------------------------------------------------------
1289 # Cleaning
1290
1291 .PHONY: clean
1292
1293 CLEAN_FILES += libraries/integer-gmp/include/HsIntegerGmp.h
1294 CLEAN_FILES += libraries/base/include/EventConfig.h
1295 CLEAN_FILES += mk/config.mk.old
1296 CLEAN_FILES += mk/project.mk.old
1297 CLEAN_FILES += compiler/ghc.cabal.old
1298
1299 # These are no longer generated, but we still clean them for a while
1300 # as they may still be in old GHC trees:
1301 CLEAN_FILES += includes/GHCConstants.h
1302 CLEAN_FILES += includes/DerivedConstants.h
1303 CLEAN_FILES += includes/ghcautoconf.h
1304 CLEAN_FILES += includes/ghcplatform.h
1305 CLEAN_FILES += includes/ghcversion.h
1306 CLEAN_FILES += utils/ghc-pkg/Version.hs
1307 CLEAN_FILES += compiler/prelude/primops.txt
1308 CLEAN_FILES += $(wildcard compiler/primop*incl)
1309
1310 clean : clean_files clean_libraries
1311
1312 .PHONY: clean_files
1313 clean_files :
1314 $(call removeFiles,$(CLEAN_FILES))
1315 # this is here since CLEAN_FILES can't handle folders
1316 $(call removeTrees,includes/dist-derivedconstants)
1317 $(call removeTrees,inplace/bin)
1318 $(call removeTrees,inplace/lib)
1319 $(call removeTrees,libraries/bootstrapping.conf)
1320
1321 .PHONY: clean_libraries
1322 clean_libraries: $(patsubst %,clean_libraries/%_dist-install,$(PACKAGES_STAGE1) $(PACKAGES_STAGE2))
1323 clean_libraries: $(patsubst %,clean_libraries/%_dist-boot,$(PACKAGES_STAGE0))
1324
1325 clean_libraries:
1326 $(call removeTrees,$(patsubst %, libraries/%/dist, $(PACKAGES_STAGE1) $(PACKAGES_STAGE2)))
1327 $(call removeFiles,$(wildcard $(patsubst %.in, %, $(wildcard $(patsubst %, libraries/%/*.buildinfo.in, $(PACKAGES_STAGE1) $(PACKAGES_STAGE2))))))
1328 $(call removeFiles,$(patsubst %, libraries/%/config.log, $(PACKAGES_STAGE1) $(PACKAGES_STAGE2)))
1329 $(call removeFiles,$(patsubst %, libraries/%/config.status, $(PACKAGES_STAGE1) $(PACKAGES_STAGE2)))
1330 $(call removeFiles,$(wildcard $(patsubst %, libraries/%/include/Hs*Config.h, $(PACKAGES_STAGE1) $(PACKAGES_STAGE2))))
1331
1332 # We have to define a clean target for each library manually, because the
1333 # libraries/*/ghc.mk files are not included when we're cleaning.
1334 ifeq "$(CLEANING)" "YES"
1335 $(foreach lib,$(PACKAGES_STAGE0),\
1336 $(eval $(call clean-target,libraries/$(lib),dist-boot,libraries/$(lib)/dist-boot)))
1337 $(foreach lib,$(PACKAGES_STAGE1) $(PACKAGES_STAGE2),\
1338 $(eval $(call clean-target,libraries/$(lib),dist-install,libraries/$(lib)/dist-install)))
1339 endif
1340
1341 clean : clean_haddock_index
1342 .PHONY: clean_haddock_index
1343 clean_haddock_index:
1344 $(call removeTrees,libraries/dist-haddock)
1345
1346 clean : clean_bindistprep
1347 .PHONY: clean_bindistprep
1348 clean_bindistprep:
1349 $(call removeTrees,bindistprep/)
1350
1351 distclean : clean
1352 # Clean the files that ./validate creates.
1353 $(call removeFiles,mk/are-validating.mk)
1354
1355 # Clean the files that we ask ./configure to create.
1356 $(call removeFiles,mk/config.mk)
1357 $(call removeFiles,mk/install.mk)
1358 $(call removeFiles,mk/project.mk)
1359 $(call removeFiles,compiler/ghc.cabal)
1360 $(call removeFiles,ghc/ghc-bin.cabal)
1361 $(call removeFiles,libraries/ghci/ghci.cabal)
1362 $(call removeFiles,utils/runghc/runghc.cabal)
1363 $(call removeFiles,settings)
1364 $(call removeFiles,docs/users_guide/ug-book.xml)
1365 $(call removeFiles,docs/users_guide/ug-ent.xml)
1366 $(call removeFiles,docs/users_guide/ghc_config.py)
1367 $(call removeFiles,docs/index.html)
1368 $(call removeFiles,libraries/prologue.txt)
1369 $(call removeFiles,distrib/configure.ac)
1370 $(call removeFiles,ch01.html ch02.html index.html)
1371
1372 # ./configure also makes these.
1373 $(call removeFiles,mk/config.h)
1374
1375 # Internal files generated by ./configure for itself.
1376 $(call removeFiles,config.cache config.status config.log)
1377
1378 # The root Makefile makes .old versions of some files that configure
1379 # generates, so we clean those too.
1380 $(call removeFiles,mk/config.mk.old)
1381 $(call removeFiles,mk/project.mk.old)
1382 $(call removeFiles,compiler/ghc.cabal.old)
1383
1384 # Clean the *Config.h files generated by library configure scripts
1385 $(call removeFiles,libraries/base/include/HsBaseConfig.h)
1386 $(call removeFiles,libraries/base/include/EventConfig.h)
1387 $(call removeFiles,libraries/directory/include/HsDirectoryConfig.h)
1388 $(call removeFiles,libraries/process/include/HsProcessConfig.h)
1389 $(call removeFiles,libraries/unix/include/HsUnixConfig.h)
1390 $(call removeFiles,libraries/time/lib/include/HsTimeConfig.h)
1391
1392 # The library configure scripts also like creating autom4te.cache
1393 # directories, so clean them all up.
1394 $(call removeTrees,$(patsubst %, libraries/%/autom4te.cache, $(PACKAGES_STAGE1) $(PACKAGES_STAGE2)))
1395
1396 # We make these when making or testing bindists
1397 $(call removeFiles,bindist-list)
1398 $(call removeTrees,bindisttest/a)
1399
1400 # Not sure why this is being cleaned here.
1401 $(call removeTrees,includes/dist-derivedconstants)
1402
1403 # Also clean Windows-only inplace directories.
1404 # Don't delete 'inplace' itself, it contains source files.
1405 $(call removeTrees,inplace/mingw)
1406 $(call removeTrees,inplace/perl)
1407
1408 maintainer-clean : distclean
1409 $(call removeFiles,configure mk/config.h.in)
1410 $(call removeTrees,autom4te.cache $(wildcard libraries/*/autom4te.cache))
1411 $(call removeFiles,$(patsubst %, libraries/%/GNUmakefile, \
1412 $(PACKAGES_STAGE1) $(PACKAGES_STAGE2)))
1413 $(call removeFiles,$(patsubst %, libraries/%/ghc.mk, $(PACKAGES_STAGE1) $(PACKAGES_STAGE2)))
1414 $(call removeFiles,$(patsubst %, libraries/%/configure, \
1415 $(PACKAGES_STAGE1) $(PACKAGES_STAGE2)))
1416 $(call removeFiles,libraries/base/include/HsBaseConfig.h.in)
1417 $(call removeFiles,libraries/directory/include/HsDirectoryConfig.h.in)
1418 $(call removeFiles,libraries/process/include/HsProcessConfig.h.in)
1419 $(call removeFiles,libraries/unix/include/HsUnixConfig.h.in)
1420 $(call removeFiles,libraries/time/lib/include/HsTimeConfig.h.in)
1421
1422 .PHONY: all_libraries
1423
1424 .PHONY: bootstrapping-files
1425 # See https://ghc.haskell.org/trac/ghc/wiki/Building/Porting
1426 bootstrapping-files: $(includes_H_CONFIG)
1427 bootstrapping-files: $(includes_DERIVEDCONSTANTS)
1428 bootstrapping-files: $(includes_GHCCONSTANTS)
1429 bootstrapping-files: $(libffi_HEADERS)
1430
1431 .DELETE_ON_ERROR:
1432
1433 # -----------------------------------------------------------------------------
1434
1435 ifeq "$(HADDOCK_DOCS)" "YES"
1436 BINDIST_HADDOCK_FLAG = --with-haddock="$(BINDIST_PREFIX)/bin/haddock"
1437 endif
1438 ifeq "$(DYNAMIC_GHC_PROGRAMS)" "YES"
1439 BINDIST_LIBRARY_FLAGS = --enable-shared --disable-library-vanilla
1440 else
1441 BINDIST_LIBRARY_FLAGS = --enable-library-vanilla --disable-shared
1442 endif
1443 BINDIST_LIBRARY_FLAGS += --disable-library-prof
1444
1445 .PHONY: validate_build_xhtml
1446 validate_build_xhtml:
1447 cd libraries/xhtml && "$(BINDIST_PREFIX)/bin/ghc" --make Setup
1448 cd libraries/xhtml && ./Setup configure --with-ghc="$(BINDIST_PREFIX)/bin/ghc" $(BINDIST_HADDOCK_FLAG) $(BINDIST_LIBRARY_FLAGS) --global --builddir=dist-bindist --prefix="$(BINDIST_PREFIX)"
1449 cd libraries/xhtml && ./Setup build --builddir=dist-bindist
1450 ifeq "$(HADDOCK_DOCS)" "YES"
1451 cd libraries/xhtml && ./Setup haddock -v0 --ghc-options=-optP-P --builddir=dist-bindist
1452 endif
1453 cd libraries/xhtml && ./Setup install --builddir=dist-bindist
1454 cd libraries/xhtml && ./Setup clean --builddir=dist-bindist
1455 cd libraries/xhtml && rm -f Setup Setup.exe Setup.hi Setup.o
1456
1457 # Note [No stage2 packages when CrossCompiling or Stage1Only]
1458 #
1459 # (first read Note [CrossCompiling vs Stage1Only] and
1460 # Note [Stage1Only vs stage=1] in mk/config.mk.in)
1461 #
1462 # When either CrossCompiling=YES or Stage1Only=YES, we have to exclude the
1463 # following packages from the build:
1464 # * packages that we build with ghc-stage2 [1]
1465 # * packages that depend on the ghc library [2]
1466 #
1467 # Here's why:
1468 # - first of all, ghc-stage1 can't use stage0's ghc library (it's too old)
1469 # - neither do we register the ghc library (compiler/stage1) that we build
1470 # with stage0. TODO Why not? We do build it...
1471 # - as a result, we need to a) use ghc-stage2 to build packages that depend on
1472 # the ghc library (e.g. ghctags [4] and mkUserGuidePart) and b) exclude
1473 # those packages when ghc-stage2 is not available.
1474 # - when Stage1Only=YES, it's clear that ghc-stage2 is not available (we just
1475 # said we didn't want it), so we have to exclude the stage2 packages from
1476 # the build. This includes the case where Stage1Only=YES is combined with
1477 # CrossCompiling=YES (Building GHC as a cross-compiler [3]).
1478 # - when CrossCompiling=YES, but Stage1Only=NO (Cross-compiling GHC itself
1479 # [3]), we can not use ghc-stage2 either. The reason is that stage2 doesn't
1480 # run on the host platform at all; it is built to run on $(TARGETPLATFORM)"
1481 # [5]. Therefore in this case we also have to exclude the stage2 packages
1482 # from the build.
1483 #
1484 # [1] find utils -name ghc.mk | xargs grep -l 'build-prog.*,2'
1485 #
1486 # [2]
1487 # find utils -name package-data.mk | xargs grep -l 'DEP_NAMES =.* ghc\($\| \)'
1488 #
1489 # [3] https://ghc.haskell.org/trac/ghc/wiki/Building/CrossCompiling
1490 #
1491 # [4] 5fb72555f7b7ab67a33583f33ad9160761ca434f
1492 # "ghctags needs the stage2 compiler, since it uses the GHC API."
1493 #
1494 # [5] * bc31dbe8ee22819054df60f5ef219fed393a1c54
1495 # "Disable any packages built with stage 2 when cross-compiling
1496 # Since we can't run stage 2 on the host."
1497 #
1498 # * 72995160b0b190577b5c0cb8d7bd0426cc455b05
1499 # "We cannot use the stage 2 compiler, it runs on $(TARGETPLATFORM)"
1500
1501 # -----------------------------------------------------------------------------
1502 # Numbered phase targets
1503
1504 # In phase 1, we'll be building dependency files for most things
1505 # built by the bootstrapping compiler while make is 'include'ing
1506 # makefiles. But in order to build dependency files, we'll need to
1507 # build any automatically generated .hs files, which means that
1508 # we'll need to be able to build any tools that generate .hs files
1509 # etc. But in order to do that, we need to already know the
1510 # dependencies for those tools, so we build their dependency files
1511 # here.
1512 .PHONY: phase_0_builds
1513 # hsc2hs is needed, e.g. to make the .hs files for hpc.
1514 phase_0_builds: $(utils/hsc2hs_dist_depfile_haskell)
1515 phase_0_builds: $(utils/hsc2hs_dist_depfile_c_asm)
1516 # genprimopcode is needed to make the .hs-incl files that are in the
1517 # ghc package.
1518 phase_0_builds: $(utils/genprimopcode_dist_depfile_haskell)
1519 phase_0_builds: $(utils/genprimopcode_dist_depfile_c_asm)
1520 # deriveConstants is used to create header files included in the
1521 # ghc package.
1522 phase_0_builds: $(utils/deriveConstants_dist_depfile_haskell)
1523 phase_0_builds: $(utils/deriveConstants_dist_depfile_c_asm)
1524
1525 .PHONY: phase_1_builds
1526 phase_1_builds: $(PACKAGE_DATA_MKS)