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