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