ghc.mk 47.2 KB
Newer Older
Ian Lynagh's avatar
Ian Lynagh committed
1

2 3 4 5 6 7 8 9 10 11 12 13
# -----------------------------------------------------------------------------
#
# (c) 2009 The University of Glasgow
#
# This file is part of the GHC build system.
#
# To understand how the build system works and how to modify it, see
#      http://hackage.haskell.org/trac/ghc/wiki/Building/Architecture
#      http://hackage.haskell.org/trac/ghc/wiki/Building/Modifying
#
# -----------------------------------------------------------------------------

Ian Lynagh's avatar
Ian Lynagh committed
14 15 16
# ToDo List.
#
#   * remove old Makefiles, add new stubs for building in subdirs
Simon Marlow's avatar
Simon Marlow committed
17 18 19 20 21 22 23
#     * docs/Makefile
#     * docs/docbook-cheat-sheet/Makefile
#     * docs/man/Makefile
#     * docs/storage-mgmt/Makefile
#     * docs/vh/Makefile
#     * rts/dotnet/Makefile
#     * utils/Makefile
Ian Lynagh's avatar
Ian Lynagh committed
24 25 26 27 28 29 30 31 32 33 34
#   * add Makefiles for the rest of the utils/ programs that aren't built
#     by default (need to exclude them from 'make all' too)

# Possible cleanups:
#
#   * per-source-file dependencies instead of one .depend file?
#   * eliminate undefined variables, and use --warn-undefined-variables?
#   * put outputs from different ways in different subdirs of distdir/build,
#     then we don't have to use -osuf/-hisuf.  We would have to install
#     them in different places too, so we'd need ghc-pkg support for packages
#     of different ways.
35
#   * make PACKAGES_STAGE1 generated by './configure' or './boot'?
Ian Lynagh's avatar
Ian Lynagh committed
36 37 38 39 40 41
#   * we should use a directory of package.conf files rather than a single
#     file for the inplace package database, so that we can express
#     dependencies more accurately.  Otherwise it's possible to get into
#     a state where the package database is out of date, and the build
#     system doesn't know.

Simon Marlow's avatar
Simon Marlow committed
42 43 44 45 46
# Approximate build order.
#
# The actual build order is defined by dependencies, and the phase
# ordering used to ensure correct ordering of makefile-generation; see
#    http://hackage.haskell.org/trac/ghc/wiki/Building/Architecture/Idiom/PhaseOrdering
Ian Lynagh's avatar
Ian Lynagh committed
47 48 49
#
#     * With bootstrapping compiler:
#           o Build utils/ghc-cabal
Simon Marlow's avatar
Simon Marlow committed
50
#           o Build utils/ghc-pkg
Ian Lynagh's avatar
Ian Lynagh committed
51 52
#           o Build utils/hsc2hs
#     * For each package:
Simon Marlow's avatar
Simon Marlow committed
53
#	    o configure, generate package-data.mk and inplace-pkg-info
Ian Lynagh's avatar
Ian Lynagh committed
54
#           o register each package into inplace/lib/package.conf
Simon Marlow's avatar
Simon Marlow committed
55 56
#     * build libffi
#     * With bootstrapping compiler:
57
#	    o Build libraries/{filepath,hpc,Cabal}
Simon Marlow's avatar
Simon Marlow committed
58
#           o Build compiler (stage 1)
Ian Lynagh's avatar
Ian Lynagh committed
59 60
#     * With stage 1:
#           o Build libraries/*
Simon Marlow's avatar
Simon Marlow committed
61
#	    o Build rts
Ian Lynagh's avatar
Ian Lynagh committed
62 63 64 65
#           o Build utils/* (except haddock)
#           o Build compiler (stage 2)
#     * With stage 2:
#           o Build utils/haddock
Simon Marlow's avatar
Simon Marlow committed
66
#           o Build compiler (stage 3) (optional)
Ian Lynagh's avatar
Ian Lynagh committed
67 68 69 70
#     * With haddock:
#           o libraries/*
#           o compiler

71 72
.PHONY: default all haddock

73 74
# We need second expansion for the way we handle directories, so that
#     | $$$$(dir $$$$@)/.
Ian Lynagh's avatar
Ian Lynagh committed
75
# expands to the directory of a rule that uses a % pattern.
76 77
.SECONDEXPANSION:

Ian Lynagh's avatar
Ian Lynagh committed
78 79
default : all

80 81 82 83 84 85 86
# Catch make if it runs away into an infinite loop
ifeq      "$(MAKE_RESTARTS)" ""
else ifeq "$(MAKE_RESTARTS)" "1"
else
$(error Make has restarted itself $(MAKE_RESTARTS) times; is there a makefile bug?)
endif

87 88 89 90
ifneq "$(CLEANING)" "YES"
CLEANING = NO
endif

Ian Lynagh's avatar
Ian Lynagh committed
91 92 93 94 95 96 97 98 99 100 101 102 103 104
# -----------------------------------------------------------------------------
# Misc GNU make utils

nothing=
space=$(nothing) $(nothing)
comma=,

# Cancel all suffix rules.  Ideally we'd like to have 'make -r' turned on
# by default, because that disables all the implicit rules, but there doesn't
# seem to be a good way to do that.  This turns off all the old-style suffix
# rules, which does half the job and speeds up make quite a bit:
.SUFFIXES:

# -----------------------------------------------------------------------------
105 106
# Makefile debugging
#
Ian Lynagh's avatar
Ian Lynagh committed
107 108 109 110 111 112 113 114 115 116
# to see the effective value used for a Makefile variable, do
#  make show VALUE=MY_VALUE
#

show:
	@echo '$(VALUE)="$($(VALUE))"'

# -----------------------------------------------------------------------------
# Include subsidiary build-system bits

117 118
include mk/tree.mk

119
ifeq "$(findstring clean,$(MAKECMDGOALS))" ""
Ian Lynagh's avatar
Ian Lynagh committed
120 121 122 123
include mk/config.mk
ifeq "$(ProjectVersion)" ""
$(error Please run ./configure first)
endif
124
endif
Ian Lynagh's avatar
Ian Lynagh committed
125

126 127
include mk/ways.mk

Ian Lynagh's avatar
Ian Lynagh committed
128 129 130
# (Optional) build-specific configuration
include mk/custom-settings.mk

131
ifeq "$(findstring clean,$(MAKECMDGOALS))" ""
132 133 134 135 136 137 138 139
ifeq "$(DYNAMIC_BY_DEFAULT)" "YES"
ifeq "$(findstring dyn,$(GhcLibWays))" ""
$(error dyn is not in $$(GhcLibWays), but $$(DYNAMIC_BY_DEFAULT) is YES)
endif
else
ifeq "$(findstring v,$(GhcLibWays))" ""
$(error v is not in $$(GhcLibWays), and $$(DYNAMIC_BY_DEFAULT) is not YES)
endif
Ian Lynagh's avatar
Ian Lynagh committed
140
endif
141 142 143 144 145
ifeq "$(GhcProfiled)" "YES"
ifeq "$(findstring p,$(GhcLibWays))" ""
$(error p is not in $$(GhcLibWays), and $$(GhcProfiled) is YES)
endif
endif
146
endif
Ian Lynagh's avatar
Ian Lynagh committed
147

148 149 150 151
ifeq "$(phase)" ""
phase = final
endif

152 153 154
# -----------------------------------------------------------------------------
# Utility definitions

155
include rules/prof.mk
156
include rules/trace.mk
157
include rules/library-path.mk
158
include rules/make-command.mk
159
include rules/pretty_commands.mk
160

Ian Lynagh's avatar
Ian Lynagh committed
161 162 163 164 165 166 167 168 169
# -----------------------------------------------------------------------------
# Macros for standard targets

include rules/all-target.mk
include rules/clean-target.mk

# -----------------------------------------------------------------------------
# The inplace tree

170
$(eval $(call clean-target,inplace,,inplace/bin inplace/lib))
Ian Lynagh's avatar
Ian Lynagh committed
171 172 173 174 175 176 177 178 179 180 181

# -----------------------------------------------------------------------------
# Whether to build dependencies or not

# When we're just doing 'make clean' or 'make show', then we don't need
# to build dependencies.

ifneq "$(findstring clean,$(MAKECMDGOALS))" ""
NO_INCLUDE_DEPS = YES
NO_INCLUDE_PKGDATA = YES
endif
Ian Lynagh's avatar
Ian Lynagh committed
182 183 184 185
ifneq "$(findstring bootstrapping-files,$(MAKECMDGOALS))" ""
NO_INCLUDE_DEPS = YES
NO_INCLUDE_PKGDATA = YES
endif
Ian Lynagh's avatar
Ian Lynagh committed
186 187 188 189 190 191 192 193 194 195 196 197 198
ifeq "$(findstring show,$(MAKECMDGOALS))" "show"
NO_INCLUDE_DEPS = YES
# We want package-data.mk for show
endif

# -----------------------------------------------------------------------------
# Ways

include rules/way-prelims.mk

$(foreach way,$(ALL_WAYS),\
  $(eval $(call way-prelims,$(way))))

199 200
ifeq "$(DYNAMIC_BY_DEFAULT)" "YES"
GHCI_WAY = dyn
201
HADDOCK_WAY = dyn
202 203
else
GHCI_WAY = v
204
HADDOCK_WAY = v
205 206
endif

Ian Lynagh's avatar
Ian Lynagh committed
207 208 209 210 211 212 213 214 215 216 217 218 219
# -----------------------------------------------------------------------------
# Compilation Flags

include rules/distdir-way-opts.mk

# -----------------------------------------------------------------------------
# Finding source files and object files

include rules/hs-sources.mk
include rules/c-sources.mk
include rules/includes-sources.mk
include rules/hs-objs.mk
include rules/c-objs.mk
220
include rules/cmm-objs.mk
Ian Lynagh's avatar
Ian Lynagh committed
221 222 223 224

# -----------------------------------------------------------------------------
# Suffix rules

225 226 227 228
# Suffix rules cause "make clean" to fail on Windows (trac #3233)
# so we don't make any when cleaning.
ifneq "$(CLEANING)" "YES"

Ian Lynagh's avatar
Ian Lynagh committed
229 230 231 232 233 234 235 236
include rules/hs-suffix-rules-srcdir.mk
include rules/hs-suffix-rules.mk
include rules/hi-rule.mk

$(foreach way,$(ALL_WAYS),\
  $(eval $(call hi-rule,$(way))))

include rules/c-suffix-rules.mk
237 238
include rules/cmm-suffix-rules.mk

239
endif # CLEANING=YES
240

Ian Lynagh's avatar
Ian Lynagh committed
241 242 243 244 245 246 247 248
# -----------------------------------------------------------------------------
# Building package-data.mk files from .cabal files

include rules/package-config.mk

# -----------------------------------------------------------------------------
# Building dependencies

249
include rules/dependencies.mk
Ian Lynagh's avatar
Ian Lynagh committed
250
include rules/build-dependencies.mk
251
include rules/include-dependencies.mk
Ian Lynagh's avatar
Ian Lynagh committed
252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274

# -----------------------------------------------------------------------------
# Build package-data.mk files

include rules/build-package-data.mk

# -----------------------------------------------------------------------------
# Build and install a program

include rules/build-prog.mk
include rules/shell-wrapper.mk

# -----------------------------------------------------------------------------
# Build a perl script

include rules/build-perl.mk

# -----------------------------------------------------------------------------
# Build a package

include rules/build-package.mk
include rules/build-package-way.mk
include rules/haddock.mk
275
include rules/tags-package.mk
276
include rules/extra-packages.mk
Ian Lynagh's avatar
Ian Lynagh committed
277 278

# -----------------------------------------------------------------------------
Ian Lynagh's avatar
Ian Lynagh committed
279
# Registering hand-written package descriptions (used in rts)
Ian Lynagh's avatar
Ian Lynagh committed
280 281 282 283 284 285 286 287 288 289 290 291 292 293

include rules/manual-package-config.mk

# -----------------------------------------------------------------------------
# Docs

include rules/docbook.mk

# -----------------------------------------------------------------------------
# Making bindists

include rules/bindist.mk

# -----------------------------------------------------------------------------
294 295 296 297 298 299 300 301 302 303 304 305
# Directories

# Don't try to delete directories:
.PRECIOUS: %/.

# Create build directories on demand.  NB. the | below: this indicates
# that $(MKDIRHIER) is an order-only dependency, which means that this
# rule fires after building mkdirhier, but we won't try to recreate
# directories if mkdirhier changes.
%/. : | $(MKDIRHIER)
	"$(MKDIRHIER)" $@

306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
# -----------------------------------------------------------------------------
# Lax dependencies

ifeq "$(LAX_DEPENDENCIES)" "YES"
LAX_DEPS_FOLLOW = |
else
LAX_DEPS_FOLLOW =
endif

# This is a bit of a hack. When LAX_DEPS_FOLLOW is | some rules end up
# looking like
#     target: a | b | c
# The first | signals the start of the order-only dependencies, but make
# treats the second | as a dependency. So we need to tell make how to
# build that dependency.

.PHONY: |
| :
	@:
325

326
# -----------------------------------------------------------------------------
327
# Properties of packages
328

329 330
# These lists say "if this package is built, here's a property it has"
# They do not say "this package will be built"; see $(PACKAGES_xx) for that
331 332

# Packages that are built but not installed
333
PKGS_THAT_ARE_INTREE_ONLY := haskeline transformers terminfo xhtml
334

335 336 337
PKGS_THAT_ARE_DPH := \
    dph/dph-base \
    dph/dph-prim-interface dph/dph-prim-seq dph/dph-prim-par \
338
    dph/dph-lifted-base \
339 340
    dph/dph-lifted-boxed dph/dph-lifted-copy dph/dph-lifted-vseg \
    vector primitive random
341

342 343
# Packages that, if present, must be built by the stage2 compiler,
# because they use TH and/or annotations, or depend on other stage2
344
# packages:
345 346
PKGS_THAT_BUILD_WITH_STAGE2 := \
    $(PKGS_THAT_ARE_DPH) old-time haskell98 haskell2010
347

348 349
# Packages that we shouldn't build if we don't have TH (e.g. because
# we're building a profiled compiler):
350
PKGS_THAT_USE_TH := $(PKGS_THAT_ARE_DPH)
351 352 353 354 355 356 357

# Packages that are built by stage0, in addition to stage1.  These
# packages are dependencies of GHC, that we do not assume the stage0
# compiler already has installed (or up-to-date enough).
#
# We assume that the stage0 compiler has a suitable bytestring package,
# so we don't have to include it below.
358
PKGS_THAT_BUILD_WITH_STAGE0 = Cabal/Cabal hpc binary bin-package-db hoopl
359

360 361 362 363 364 365 366
# $(EXTRA_PACKAGES)  is another classification, of packages built but
#                    not installed
#                    It is set in rules/extra-package.mk, 
#                    by $(call extra-packages) a little further down 
#                    this ghc.mk 


367 368

# ----------------------------------------------------------------------------
369 370 371
# Packages to build
# The lists of packages that we *actually* going to build in each stage:
#
372 373 374
#  $(PACKAGES_STAGE0) 
#  $(PACKAGES_STAGE1)
#  $(PACKAGES_STAGE2)
375
#
376 377 378 379 380 381 382 383 384
# These are automatically derived from
#    (a) the set of packages in this source tree
#    (b) the predicates above, e.g. $(PKGS_THAT_BUILD_WITH_STAGE2)
#    (c) which platform we're on, and a few other things


# no processing to do on this one: it really is the list of packages
# to build with stage 0.
PACKAGES_STAGE0 = $(PKGS_THAT_BUILD_WITH_STAGE0)
Ian Lynagh's avatar
Ian Lynagh committed
385

386 387 388 389 390
define addPackageGeneral
# args: $1 = PACKAGES variable, $2 = package, $3 = condition
    ifeq "$3" ""
        $1 += $2
    else
391
        ifeq "$$(CLEANING)" "YES"
392
            $1 += $2
393
        else
394 395
            ifeq $3
                $1 += $2
396 397 398 399 400
            endif
        endif
    endif
endef

401
define addPackage # args: $1 = package, $2 = condition
402 403
ifneq "$(filter $1,$(PKGS_THAT_USE_TH)) $(GhcProfiled)" "$1 YES"
ifeq "$(filter $1,$(PKGS_THAT_BUILD_WITH_STAGE2))" "$1"
404
ifneq "$(BuildingCrossCompiler)" "YES"
405
$(call addPackageGeneral,PACKAGES_STAGE2,$1,$2)
406
endif
407
else
408
$(call addPackageGeneral,PACKAGES_STAGE1,$1,$2)
409
endif
410
endif
411 412
endef

413 414 415
# Add all the packages. Note that we need to add them in dependency
# order, as this is the order that they get configured in.

416
$(eval $(call addPackage,ghc-prim))
417 418 419 420
ifeq "$(CLEANING)" "YES"
$(eval $(call addPackage,integer-gmp))
$(eval $(call addPackage,integer-simple))
else
421
$(eval $(call addPackage,$(INTEGER_LIBRARY)))
422
endif
423 424 425
$(eval $(call addPackage,base))
$(eval $(call addPackage,filepath))
$(eval $(call addPackage,array))
Ian Lynagh's avatar
Ian Lynagh committed
426
$(eval $(call addPackage,deepseq))
Ian Lynagh's avatar
Ian Lynagh committed
427
$(eval $(call addPackage,bytestring))
428
$(eval $(call addPackage,containers))
429 430
$(eval $(call addPackage,old-locale))
$(eval $(call addPackage,old-time))
431 432

$(eval $(call addPackage,Win32,($$(Windows),YES)))
433
$(eval $(call addPackage,time))
434 435 436 437 438
$(eval $(call addPackage,unix,($$(Windows),NO)))

$(eval $(call addPackage,directory))
$(eval $(call addPackage,process))
$(eval $(call addPackage,haskell98))
Simon Marlow's avatar
Simon Marlow committed
439
$(eval $(call addPackage,haskell2010))
440 441 442
$(eval $(call addPackage,hpc))
$(eval $(call addPackage,pretty))
$(eval $(call addPackage,template-haskell))
443
$(eval $(call addPackage,Cabal/Cabal))
444 445
$(eval $(call addPackage,binary))
$(eval $(call addPackage,bin-package-db))
446
$(eval $(call addPackage,hoopl))
447
$(eval $(call addPackage,transformers))
448
$(eval $(call addPackage,xhtml))
449
$(eval $(call addPackage,terminfo,($$(Windows),NO)))
450
$(eval $(call addPackage,haskeline))
Ian Lynagh's avatar
Ian Lynagh committed
451

452
$(eval $(call extra-packages))
453

454 455
# -------------------------------------------
# Dependencies between package-data.mk files
Ian Lynagh's avatar
Ian Lynagh committed
456 457 458

# We cannot run ghc-cabal to configure a package until we have
# configured and registered all of its dependencies.  So the following
459 460
# hack forces all the configure steps to happen in exactly the following order:
#
461
#  $(PACKAGES_STAGE1) ghc(stage2) $(PACKAGES_STAGE2)
462 463 464
#
# Ideally we should use the correct dependencies here to allow more
# parallelism, but we don't know the dependencies until we've
Gabor Greif's avatar
Gabor Greif committed
465
# generated the package-data.mk files.
Ian Lynagh's avatar
Ian Lynagh committed
466
define fixed_pkg_dep
467 468
libraries/$1/$2/package-data.mk : $$(GHC_PKG_INPLACE) $$(fixed_pkg_prev)
fixed_pkg_prev:=libraries/$1/$2/package-data.mk
Ian Lynagh's avatar
Ian Lynagh committed
469 470 471 472
endef

ifneq "$(BINDIST)" "YES"
fixed_pkg_prev=
473
$(foreach pkg,$(PACKAGES_STAGE1),$(eval $(call fixed_pkg_dep,$(pkg),dist-install)))
474 475 476 477 478 479 480

# the GHC package doesn't live in libraries/, so we add its dependency manually:
compiler/stage2/package-data.mk: $(fixed_pkg_prev)
fixed_pkg_prev:=compiler/stage2/package-data.mk

# and continue with PACKAGES_STAGE2, which depend on GHC:
$(foreach pkg,$(PACKAGES_STAGE2),$(eval $(call fixed_pkg_dep,$(pkg),dist-install)))
Ian Lynagh's avatar
Ian Lynagh committed
481

482 483
ghc/stage1/package-data.mk: compiler/stage1/package-data.mk
ghc/stage2/package-data.mk: compiler/stage2/package-data.mk
Ian Lynagh's avatar
Ian Lynagh committed
484 485 486 487
# haddock depends on ghc and some libraries, but depending on GHC's
# package-data.mk is sufficient, as that in turn depends on all the
# libraries
utils/haddock/dist/package-data.mk: compiler/stage2/package-data.mk
488
utils/ghc-pwd/dist-install/package-data.mk: compiler/stage2/package-data.mk
489
utils/ghc-cabal/dist-install/package-data.mk: compiler/stage2/package-data.mk
Ian Lynagh's avatar
Ian Lynagh committed
490

Ian Lynagh's avatar
Ian Lynagh committed
491 492
utils/ghctags/dist-install/package-data.mk: compiler/stage2/package-data.mk
utils/hpc/dist-install/package-data.mk: compiler/stage2/package-data.mk
493
utils/ghc-pkg/dist-install/package-data.mk: compiler/stage2/package-data.mk
Ian Lynagh's avatar
Ian Lynagh committed
494
utils/hsc2hs/dist-install/package-data.mk: compiler/stage2/package-data.mk
495 496
utils/compare_sizes/dist-install/package-data.mk: compiler/stage2/package-data.mk
utils/runghc/dist-install/package-data.mk: compiler/stage2/package-data.mk
497
utils/mkUserGuidePart/dist/package-data.mk: compiler/stage2/package-data.mk
Ian Lynagh's avatar
Ian Lynagh committed
498

Ian Lynagh's avatar
Ian Lynagh committed
499
# add the final package.conf dependency: ghc-prim depends on RTS
Ian Lynagh's avatar
Ian Lynagh committed
500 501 502
libraries/ghc-prim/dist-install/package-data.mk : rts/package.conf.inplace
endif

503 504
# --------------------------------
# Misc package-related settings
505

506
BOOT_PKG_CONSTRAINTS := \
507
    $(foreach d,$(PACKAGES_STAGE0),\
508 509
        $(foreach p,$(basename $(notdir $(wildcard libraries/$d/*.cabal))),\
            --constraint "$p == $(shell grep -i "^Version:" libraries/$d/$p.cabal | sed "s/[^0-9.]//g")"))
Simon Marlow's avatar
Simon Marlow committed
510

511
# The actual .a and .so/.dll files: needed for dependencies.
512
ALL_STAGE1_LIBS  = $(foreach lib,$(PACKAGES_STAGE1),$(libraries/$(lib)_dist-install_v_LIB))
513
ifeq "$(BuildSharedLibs)" "YES"
514
ALL_STAGE1_LIBS += $(foreach lib,$(PACKAGES_STAGE1),$(libraries/$(lib)_dist-install_dyn_LIB))
515
endif
516
BOOT_LIBS = $(foreach lib,$(PACKAGES_STAGE0),$(libraries/$(lib)_dist-boot_v_LIB))
517

518
# ----------------------------------------
Ian Lynagh's avatar
Ian Lynagh committed
519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535
# Special magic for the ghc-prim package

# We want the ghc-prim package to include the GHC.Prim module when it
# is registered, but not when it is built, because GHC.Prim is not a
# real source module, it is built-in to GHC.  The old build system did
# this using Setup.hs, but we can't do that here, so we have a flag to
# enable GHC.Prim in the .cabal file (so that the ghc-prim package
# remains compatible with the old build system for the time being).
# GHC.Prim module in the ghc-prim package with a flag:
#
libraries/ghc-prim_CONFIGURE_OPTS += --flag=include-ghc-prim

# And then we strip it out again before building the package:
define libraries/ghc-prim_PACKAGE_MAGIC
libraries/ghc-prim_dist-install_MODULES := $$(filter-out GHC.Prim,$$(libraries/ghc-prim_dist-install_MODULES))
endef

536
PRIMOPS_TXT_STAGE1 = compiler/stage1/build/primops.txt
Ian Lynagh's avatar
Ian Lynagh committed
537

538 539
libraries/ghc-prim/dist-install/build/GHC/PrimopWrappers.hs : $(GENPRIMOP_INPLACE) $(PRIMOPS_TXT_STAGE1) | $$(dir $$@)/.
	"$(GENPRIMOP_INPLACE)" --make-haskell-wrappers < $(PRIMOPS_TXT_STAGE1) >$@
Ian Lynagh's avatar
Ian Lynagh committed
540

541 542
# Required so that Haddock documents the primops.
libraries/ghc-prim_dist-install_EXTRA_HADDOCK_SRCS = libraries/ghc-prim/dist-install/build/autogen/GHC/Prim.hs
Ian Lynagh's avatar
Ian Lynagh committed
543

544 545 546 547 548 549
# ----------------------------------------
# Special magic for the integer package

ifneq "$(CLEANING)" "YES"
ifeq "$(INTEGER_LIBRARY)" "integer-gmp"
libraries/base_dist-install_CONFIGURE_OPTS += --flags=-integer-simple
Ian Lynagh's avatar
Ian Lynagh committed
550 551
else ifeq "$(INTEGER_LIBRARY)" "integer-simple"
libraries/base_dist-install_CONFIGURE_OPTS += --flags=integer-simple
552 553 554 555 556
else
$(error Unknown integer library: $(INTEGER_LIBRARY))
endif
endif

557 558 559 560 561 562 563 564 565 566 567 568
# ----------------------------------------
# Workarounds for problems building DLLs on Windows

ifeq "$(TargetOS_CPP)" "mingw32"
# We don't build the GHC package the dyn way on Windows, so
# we can't build these packages the dyn way either. See trac #5987
libraries/dph/dph-lifted-base_dist-install_EXCLUDED_WAYS := dyn
libraries/dph/dph-lifted-boxed_dist-install_EXCLUDED_WAYS := dyn
libraries/dph/dph-lifted-copy_dist-install_EXCLUDED_WAYS := dyn
libraries/dph/dph-lifted-vseg_dist-install_EXCLUDED_WAYS := dyn
endif

569 570 571
# ----------------------------------------------
# Checking packages with 'cabal check'

572
ifeq "$(phase)" "final"
573 574 575
ifeq "$(CHECK_PACKAGES)" "YES"
all: check_packages
endif
Ian Lynagh's avatar
Ian Lynagh committed
576
endif
577 578 579 580 581 582 583 584 585

# These packages don't pass the Cabal checks because hs-source-dirs
# points outside the source directory. This isn't a real problem in
# these cases, so we just skip checking them.
# NB. these must come before we include the ghc.mk files below, because
# they disable the relevant rules.
# In compiler's case, include-dirs points outside of the source tree
CHECKED_compiler = YES

Ian Lynagh's avatar
Ian Lynagh committed
586 587 588 589 590 591 592 593
# -----------------------------------------------------------------------------
# Include build instructions from all subdirs

ifneq "$(BINDIST)" "YES"
BUILD_DIRS += \
   $(GHC_MKDIRHIER_DIR)
endif

594 595 596 597 598
ifeq "$(Windows)" "YES"
BUILD_DIRS += \
   $(GHC_TOUCHY_DIR)
endif

Ian Lynagh's avatar
Ian Lynagh committed
599 600
BUILD_DIRS += \
   docs/users_guide \
601
   docs/man \
Ian Lynagh's avatar
Ian Lynagh committed
602 603 604
   $(GHC_UNLIT_DIR) \
   $(GHC_HP2PS_DIR)

Ian Lynagh's avatar
Ian Lynagh committed
605 606 607 608 609
ifneq "$(GhcUnregisterised)" "YES"
BUILD_DIRS += \
   $(GHC_SPLIT_DIR)
endif

Ian Lynagh's avatar
Ian Lynagh committed
610 611 612 613 614
ifneq "$(BINDIST)" "YES"
BUILD_DIRS += \
   $(GHC_GENPRIMOP_DIR)
endif

615 616 617 618 619 620
ifeq "$(BuildingCrossCompiler)-$(phase)" "YES-final"
MAYBE_GHCI=
else
MAYBE_GHCI=driver/ghci
endif

Ian Lynagh's avatar
Ian Lynagh committed
621 622
BUILD_DIRS += \
   driver \
623
   $(MAYBE_GHCI) \
Ian Lynagh's avatar
Ian Lynagh committed
624
   driver/ghc \
625
   driver/haddock \
Ian Lynagh's avatar
Ian Lynagh committed
626 627 628 629 630 631
   libffi \
   includes \
   rts

ifneq "$(BINDIST)" "YES"
BUILD_DIRS += \
Ian Lynagh's avatar
Ian Lynagh committed
632
   bindisttest \
Ian Lynagh's avatar
Ian Lynagh committed
633 634 635
   $(GHC_GENAPPLY_DIR)
endif

636 637
ifneq "$(CLEANING)" "YES"
BUILD_DIRS += \
638
   $(patsubst %, libraries/%, $(PACKAGES_STAGE1))
639 640
endif

641 642
ifeq "$(INTEGER_LIBRARY)" "integer-gmp"
BUILD_DIRS += libraries/integer-gmp/gmp
Ian Lynagh's avatar
Ian Lynagh committed
643 644
else ifneq "$(findstring clean,$(MAKECMDGOALS))" ""
BUILD_DIRS += libraries/integer-gmp/gmp
645 646
endif

647 648 649 650 651 652 653 654 655 656 657 658
ifeq "$(BuildingCrossCompiler)-$(phase)" "YES-final"
MAYBE_COMPILER=
MAYBE_GHCTAGS=
MAYBE_HPC=
MAYBE_RUNGHC=
else
MAYBE_COMPILER=compiler
MAYBE_GHCTAGS=utils/ghctags
MAYBE_HPC=utils/hpc
MAYBE_RUNGHC=utils/runghc
endif

659
BUILD_DIRS += \
660 661
   utils/haddock \
   utils/haddock/doc \
662
   $(MAYBE_COMPILER) \
Ian Lynagh's avatar
Ian Lynagh committed
663 664
   $(GHC_HSC2HS_DIR) \
   $(GHC_PKG_DIR) \
665
   utils/deriveConstants \
666
   utils/testremove \
667
   $(MAYBE_GHCTAGS) \
668
   utils/ghc-pwd \
669
   $(GHC_CABAL_DIR) \
670 671
   $(MAYBE_HPC) \
   $(MAYBE_RUNGHC) \
Ian Lynagh's avatar
Ian Lynagh committed
672 673
   ghc

674
ifneq "$(BINDIST)" "YES"
675
ifneq "$(BuildingCrossCompiler)-$(phase)" "YES-final"
676 677 678
BUILD_DIRS += \
   utils/mkUserGuidePart
endif
679
endif
680

681 682 683
BUILD_DIRS += utils/count_lines
BUILD_DIRS += utils/compare_sizes

684 685 686 687 688 689
ifneq "$(CLEANING)" "YES"
# After compiler/, because these packages depend on it
BUILD_DIRS += \
   $(patsubst %, libraries/%, $(PACKAGES_STAGE2))
endif

Ian Lynagh's avatar
Ian Lynagh committed
690 691
# ----------------------------------------------
# Actually include all the sub-ghc.mk's
Ian Lynagh's avatar
Ian Lynagh committed
692

693 694 695
# BUILD_DIRS_EXTRA needs to come after BUILD_DIRS, because stuff in
# libraries/dph/ghc.mk refers to stuff defined earlier, in particular
# things like $(libraries/dph/dph-base_dist-install_GHCI_LIB)
696 697 698
ifeq "$(GhcProfiled)" "YES"
BUILD_DIRS_EXTRA := $(filter-out libraries/dph,$(BUILD_DIRS_EXTRA))
endif
699
include $(patsubst %, %/ghc.mk, $(BUILD_DIRS) $(BUILD_DIRS_EXTRA))
Ian Lynagh's avatar
Ian Lynagh committed
700

Simon Marlow's avatar
Simon Marlow committed
701 702 703 704 705
# A useful pseudo-target (must be after the include above, because it needs
# the value of things like $(libraries/base_dist-install_v_LIB).
.PHONY: stage1_libs
stage1_libs : $(ALL_STAGE1_LIBS)

706 707 708 709 710 711 712 713 714
# ----------------------------------------------
# Per-package compiler flags
# 
# If you want to add per-package compiler flags, this 
# is the place to do it.  Do it like this for package <pkg>
#   
#   libraries/<pkg>_dist-boot_HC_OPTS += -Wwarn
#   libraries/<pkg>_dist-install_HC_OPTS += -Wwarn

715
# Add $(GhcLibHcOpts) to all package builds
716
$(foreach pkg,$(PACKAGES_STAGE1) $(PACKAGES_STAGE2),$(eval libraries/$(pkg)_dist-install_HC_OPTS += $$(GhcLibHcOpts)))
717

718
# Add $(GhcBootLibHcOpts) to all stage0 package builds
719
$(foreach pkg,$(PACKAGES_STAGE0),$(eval libraries/$(pkg)_dist-boot_HC_OPTS += $$(GhcBootLibHcOpts)))
720 721 722

# -----------------------------------------------
# Haddock-related bits
723

724
# Don't run Haddock for the package that will not be installed
725
$(foreach p,$(PKGS_THAT_ARE_INTREE_ONLY),$(eval libraries/$p_dist-install_DO_HADDOCK = NO))
726
# We don't haddock the bootstrapping libraries
727
$(foreach p,$(PACKAGES_STAGE0),$(eval libraries/$p_dist-boot_DO_HADDOCK = NO))
728 729

# Build the Haddock contents and index
730
ifeq "$(HADDOCK_DOCS)" "YES"
731
libraries/dist-haddock/index.html: inplace/bin/haddock$(exeext) $(ALL_HADDOCK_FILES)
732
	cd libraries && sh gen_contents_index --inplace
733
ifeq "$(phase)" "final"
734
$(eval $(call all-target,library_doc_index,libraries/dist-haddock/index.html))
Ian Lynagh's avatar
Ian Lynagh committed
735
endif
736
INSTALL_LIBRARY_DOCS += libraries/dist-haddock/*
737
endif
738

Ian Lynagh's avatar
Ian Lynagh committed
739 740 741 742 743 744 745 746
# -----------------------------------------------------------------------------
# Bootstrapping libraries

# We need to build a few libraries with the installed GHC, since GHC itself
# and some of the tools depend on them:

ifneq "$(BINDIST)" "YES"

747
ifneq "$(BOOTSTRAPPING_CONF)" ""
Ian Lynagh's avatar
Ian Lynagh committed
748 749 750
ifeq "$(wildcard $(BOOTSTRAPPING_CONF))" ""
$(shell echo "[]" >$(BOOTSTRAPPING_CONF))
endif
751
endif
Ian Lynagh's avatar
Ian Lynagh committed
752 753 754 755 756 757 758

$(eval $(call clean-target,$(BOOTSTRAPPING_CONF),,$(BOOTSTRAPPING_CONF)))

# register the boot packages in strict sequence, because running
# multiple ghc-pkgs in parallel doesn't work (registrations may get
# lost).
fixed_pkg_prev=
759
$(foreach pkg,$(PACKAGES_STAGE0),$(eval $(call fixed_pkg_dep,$(pkg),dist-boot)))
Ian Lynagh's avatar
Ian Lynagh committed
760

761
compiler/stage1/package-data.mk : $(fixed_pkg_prev)
762
endif
Ian Lynagh's avatar
Ian Lynagh committed
763

764
ifneq "$(BINDIST)" "YES"
765 766 767 768
# Make sure we have all the GHCi libs by the time we've built
# ghc-stage2.  DPH includes a bit of Template Haskell which needs the
# GHCI libs, and we don't have a better way to express that dependency.
#
769
GHCI_LIBS = $(foreach lib,$(PACKAGES_STAGE1),$(libraries/$(lib)_dist-install_GHCI_LIB)) \
770 771
	    $(compiler_stage2_GHCI_LIB)

772
ifeq "$(UseArchivesForGhci)" "NO"
773
ghc/stage2/build/tmp/$(ghc_stage2_PROG) : $(GHCI_LIBS)
774
endif
775

Ian Lynagh's avatar
Ian Lynagh committed
776 777 778 779 780 781
ifeq "$(UseArchivesForGhci)" "YES"
GHCI_lib_way = v
else
GHCI_lib_way = GHCI
endif

Ian Lynagh's avatar
Ian Lynagh committed
782 783 784
# Deps for TH uses in libraries
$(foreach way, $(GhcLibWays),$(eval \
libraries/vector/dist-install/build/Data/Vector/Fusion/Stream/Monadic.$($(way)_osuf): \
Ian Lynagh's avatar
Ian Lynagh committed
785
    $(libraries/primitive_dist-install_$(GHCI_lib_way)_LIB) \
Ian Lynagh's avatar
Ian Lynagh committed
786
  ))
Ian Lynagh's avatar
Ian Lynagh committed
787 788 789 790 791 792 793 794 795 796
endif

# -----------------------------------------------------------------------------
# Creating a local mingw copy on Windows

ifeq "$(Windows)" "YES"

install : install_mingw
.PHONY: install_mingw
install_mingw : $(INPLACE_MINGW)
797
	"$(CP)" -Rp $(INPLACE_MINGW) $(prefix)
Ian Lynagh's avatar
Ian Lynagh committed
798

Ian Lynagh's avatar
Ian Lynagh committed
799 800 801 802 803
install : install_perl
.PHONY: install_perl
install_perl : $(INPLACE_PERL)
	"$(CP)" -Rp $(INPLACE_PERL) $(prefix)

Ian Lynagh's avatar
Ian Lynagh committed
804 805
endif # Windows

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
Ian Lynagh's avatar
Ian Lynagh committed
810 811

libraries/ghc-prim/dist-install/build/autogen/GHC/Prim.hs: \
812
                            $(PRIMOPS_TXT_STAGE1) $(GENPRIMOP_INPLACE) \
813
                          | $$(dir $$@)/.
814
	"$(GENPRIMOP_INPLACE)" --make-haskell-source < $< > $@
Ian Lynagh's avatar
Ian Lynagh committed
815

816 817 818
.PHONY: tags
tags: tags_compiler

819 820 821
.PHONY: TAGS
TAGS: TAGS_compiler

Ian Lynagh's avatar
Ian Lynagh committed
822 823 824
# -----------------------------------------------------------------------------
# Installation

825
install: install_libs install_packages install_libexecs \
826
         install_bins install_topdirs
Ian Lynagh's avatar
Ian Lynagh committed
827 828 829
ifeq "$(HADDOCK_DOCS)" "YES"
install: install_docs
endif
Ian Lynagh's avatar
Ian Lynagh committed
830

831 832 833 834 835
define installLibsTo
# $1 = libraries to install
# $2 = directory to install to
	$(call INSTALL_DIR,$2)
	for i in $1; do \
Ian Lynagh's avatar
Ian Lynagh committed
836 837
		case $$i in \
		  *.a) \
838
		    $(call INSTALL_DATA,$(INSTALL_OPTS),$$i,$2); \
ian@well-typed.com's avatar
ian@well-typed.com committed
839
		    $(RANLIB) $2/`basename $$i` ;; \
Ian Lynagh's avatar
Ian Lynagh committed
840
		  *.dll) \
841
		    $(call INSTALL_PROGRAM,$(INSTALL_OPTS),$$i,$2) ; \
842
		    $(STRIP_CMD) $2/`basename $$i` ;; \
Ian Lynagh's avatar
Ian Lynagh committed
843
		  *.so) \
844
		    $(call INSTALL_SHLIB,$(INSTALL_OPTS),$$i,$2) ;; \
Ian Lynagh's avatar
Ian Lynagh committed
845
		  *.dylib) \
846
		    $(call INSTALL_SHLIB,$(INSTALL_OPTS),$$i,$2);; \
Ian Lynagh's avatar
Ian Lynagh committed
847
		  *) \
848
		    $(call INSTALL_DATA,$(INSTALL_OPTS),$$i,$2); \
Ian Lynagh's avatar
Ian Lynagh committed
849 850
		esac; \
	done
851 852 853 854 855 856 857 858 859 860
endef

install_bins: $(INSTALL_BINS)
	$(call INSTALL_DIR,"$(DESTDIR)$(bindir)")
	for i in $(INSTALL_BINS); do \
		$(call INSTALL_PROGRAM,$(INSTALL_BIN_OPTS),$$i,"$(DESTDIR)$(bindir)") ;  \
	done

install_libs: $(INSTALL_LIBS)
	$(call installLibsTo, $(INSTALL_LIBS), "$(DESTDIR)$(ghclibdir)")
Ian Lynagh's avatar
Ian Lynagh committed
861 862

install_libexecs:  $(INSTALL_LIBEXECS)
863 864 865
ifeq "$(INSTALL_LIBEXECS)" ""
	@:
else
866
	$(call INSTALL_DIR,"$(DESTDIR)$(ghclibexecdir)/bin")
Ian Lynagh's avatar
Ian Lynagh committed
867
	for i in $(INSTALL_LIBEXECS); do \
868
		$(call INSTALL_PROGRAM,$(INSTALL_BIN_OPTS),$$i,"$(DESTDIR)$(ghclibexecdir)/bin"); \
869
	done
870 871
# We rename ghc-stage2, so that the right program name is used in error
# 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)"); \
Ian Lynagh's avatar
Ian Lynagh committed
879 880
	done

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 889
	$(call INSTALL_DIR,"$(DESTDIR)$(docdir)/html")
	$(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 896
	$(call INSTALL_DATA,$(INSTALL_OPTS),libraries/prologue.txt,"$(DESTDIR)$(docdir)/html/libraries/")
	$(call INSTALL_SCRIPT,$(INSTALL_OPTS),libraries/gen_contents_index,"$(DESTDIR)$(docdir)/html/libraries/")
897 898
endif
ifneq "$(INSTALL_HTML_DOC_DIRS)" ""
899
	for i in $(INSTALL_HTML_DOC_DIRS); do \
900 901
		$(call INSTALL_DIR,"$(DESTDIR)$(docdir)/html/`basename $$i`"); \
		$(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
Ian Lynagh's avatar
Ian Lynagh committed
906 907 908 909

# Install packages in the right order, so that ghc-pkg doesn't complain.
# Also, install ghc-pkg first.
ifeq "$(Windows)" "NO"
910 911
INSTALLED_GHC_REAL=$(DESTDIR)$(ghclibexecdir)/bin/ghc
INSTALLED_GHC_PKG_REAL=$(DESTDIR)$(ghclibexecdir)/bin/ghc-pkg
Ian Lynagh's avatar
Ian Lynagh committed
912
else
Simon Marlow's avatar
Simon Marlow committed
913
INSTALLED_GHC_REAL=$(DESTDIR)$(bindir)/ghc.exe
Ian Lynagh's avatar
Ian Lynagh committed
914 915 916
INSTALLED_GHC_PKG_REAL=$(DESTDIR)$(bindir)/ghc-pkg.exe
endif

917 918 919 920 921
INSTALLED_PKG_DIRS := $(addprefix libraries/,$(PACKAGES_STAGE1))
ifeq "$(BuildingCrossCompiler)" "NO"
INSTALLED_PKG_DIRS := $(INSTALLED_PKG_DIRS) compiler
endif
INSTALLED_PKG_DIRS := $(INSTALLED_PKG_DIRS) $(addprefix libraries/,$(PACKAGES_STAGE2))
922
ifeq "$(InstallExtraPackages)" "NO"
923 924
INSTALLED_PKG_DIRS := $(filter-out $(addprefix libraries/,$(EXTRA_PACKAGES)),\
                                   $(INSTALLED_PKG_DIRS))
925
endif
926
INSTALLED_PKG_DIRS := $(filter-out $(addprefix libraries/,$(PKGS_THAT_ARE_INTREE_ONLY)),\
927
                                   $(INSTALLED_PKG_DIRS))
928

929 930 931
# Set the INSTALL_DISTDIR_p for each package; compiler is special
$(foreach p,$(filter-out compiler,$(INSTALLED_PKG_DIRS)),\
   $(eval INSTALL_DISTDIR_$p = dist-install))
Ian Lynagh's avatar
Ian Lynagh committed
932 933
INSTALL_DISTDIR_compiler = stage2

934
# Now we can do the installation
Ian Lynagh's avatar
Ian Lynagh committed
935
install_packages: install_libexecs
Ian Lynagh's avatar
Ian Lynagh committed
936
install_packages: rts/package.conf.install
937
	$(call INSTALL_DIR,"$(DESTDIR)$(topdir)")
938
	$(call removeTrees,"$(INSTALLED_PACKAGE_CONF)")
939
	$(call INSTALL_DIR,"$(INSTALLED_PACKAGE_CONF)")
940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955
	$(call INSTALL_DIR,"$(DESTDIR)$(topdir)/rts-1.0")
	$(call installLibsTo, $(RTS_INSTALL_LIBS), "$(DESTDIR)$(topdir)/rts-1.0")
ifeq "$(DYNAMIC_BY_DEFAULT)" "YES"
	$(foreach p, $(PKGS_THAT_ARE_INTREE_ONLY), \
	    $(call installLibsTo, $(wildcard libraries/$p/dist-install/build/*.so libraries/$p/dist-install/build/*.dll libraries/$p/dist-install/build/*.dylib), "$(DESTDIR)$(topdir)/$p-$(libraries/$p_dist-install_VERSION)"))
endif
	$(foreach p, $(INSTALLED_PKG_DIRS),                           \
	    $(call make-command,                                      \
	           CROSS_COMPILE="$(CrossCompilePrefix)"              \
	           "$(GHC_CABAL_INPLACE)" copy                        \
	                                  "$(STRIP_CMD)"              \
	                                  $p $(INSTALL_DISTDIR_$p)    \
	                                  '$(DESTDIR)'                \
	                                  '$(prefix)'                 \
	                                  '$(ghclibdir)'              \
	                                  '$(docdir)/html/libraries'))
956
	"$(INSTALLED_GHC_PKG_REAL)" --force --global-package-db "$(INSTALLED_PACKAGE_CONF)" update rts/package.conf.install
957
	$(foreach p, $(INSTALLED_PKG_DIRS),                           \
958
	    $(call make-command,                                      \
959 960
	           CROSS_COMPILE="$(CrossCompilePrefix)"              \
	           "$(GHC_CABAL_INPLACE)" register                    \
961 962 963 964 965 966 967 968 969
	                                  "$(INSTALLED_GHC_REAL)"     \
	                                  "$(INSTALLED_GHC_PKG_REAL)" \
	                                  "$(DESTDIR)$(topdir)"       \
	                                  $p $(INSTALL_DISTDIR_$p)    \
	                                  '$(DESTDIR)'                \
	                                  '$(prefix)'                 \
	                                  '$(ghclibdir)'              \
	                                  '$(docdir)/html/libraries'  \
	                                  $(RelocatableBuild)))
970
# when we install the packages above, ghc-pkg obeys umask when creating
971 972 973 974 975
# the package.conf files, but for everything else we specify the
# permissions. We therefore now fix the permissions of package.cache.
# This means "sudo make install" does the right thing even if it runs
# with an 077 umask.
	for f in '$(INSTALLED_PACKAGE_CONF)'/*; do $(CREATE_DATA) "$$f"; done
Ian Lynagh's avatar
Ian Lynagh committed
976 977 978 979

# -----------------------------------------------------------------------------
# Binary distributions

Simon Marlow's avatar
Simon Marlow committed
980 981 982 983
ifneq "$(CLEANING)" "YES"
# This rule seems to hold some files open on Windows which prevents
# cleaning, perhaps due to the $(wildcard).

Ian Lynagh's avatar
Ian Lynagh committed
984
$(eval $(call bindist,.,\
Ian Lynagh's avatar
Ian Lynagh committed
985
    LICENSE \
986 987
    README \
    INSTALL \
Ian Lynagh's avatar
Ian Lynagh committed
988
    configure config.sub config.guess install-sh \
989
    settings.in \
990
    packages \
Ian Lynagh's avatar
Ian Lynagh committed
991 992 993
    Makefile \
    mk/config.mk.in \
    $(INPLACE_BIN)/mkdirhier \
994
    utils/ghc-cabal/dist-install/build/tmp/ghc-cabal \
995
    utils/ghc-pwd/dist-install/build/tmp/ghc-pwd \
Ian Lynagh's avatar
Ian Lynagh committed
996 997 998 999 1000
    $(BINDIST_WRAPPERS) \
    $(BINDIST_PERL_SOURCES) \
    $(BINDIST_LIBS) \
    $(BINDIST_HI) \
    $(BINDIST_EXTRAS) \
1001
    $(includes_H_FILES) \
Ian Lynagh's avatar
Ian Lynagh committed
1002 1003
    $(includes_DERIVEDCONSTANTS) \
    $(includes_GHCCONSTANTS) \
1004
    $(libffi_HEADERS) \
Ian Lynagh's avatar
Ian Lynagh committed
1005 1006
    $(INSTALL_LIBEXECS) \
    $(INSTALL_LIBEXEC_SCRIPTS) \
1007
    $(INSTALL_TOPDIRS) \
Ian Lynagh's avatar
Ian Lynagh committed
1008
    $(INSTALL_BINS) \
1009
    $(INSTALL_MANPAGES) \
Ian Lynagh's avatar
Ian Lynagh committed
1010
    $(INSTALL_DOCS) \
1011
    $(INSTALL_LIBRARY_DOCS) \
Ian Lynagh's avatar
Ian Lynagh committed
1012
    $(addsuffix /*,$(INSTALL_HTML_DOC_DIRS)) \
Ian Lynagh's avatar
Ian Lynagh committed
1013 1014 1015 1016
    docs/index.html \
    compiler/stage2/doc \
    $(wildcard libraries/*/dist-install/doc/) \
    $(wildcard libraries/*/*/dist-install/doc/) \
1017
    $(filter-out settings,$(INSTALL_LIBS)) \
1018
    $(RTS_INSTALL_LIBS) \
1019
    $(filter-out %/project.mk mk/config.mk %/mk/install.mk,$(MAKEFILE_LIST)) \
Ian Lynagh's avatar
Ian Lynagh committed
1020 1021 1022 1023 1024
    mk/project.mk \
    mk/install.mk.in \
    bindist.mk \
    libraries/gen_contents_index \
    libraries/prologue.txt \
1025 1026 1027 1028
    $(wildcard libraries/dph/LICENSE \
               libraries/dph/ghc-packages \
               libraries/dph/ghc-packages2 \
               libraries/dph/ghc-stage2-package) \
Ian Lynagh's avatar
Ian Lynagh committed
1029
 ))
Simon Marlow's avatar
Simon Marlow committed
1030
endif
Ian Lynagh's avatar
Ian Lynagh committed
1031 1032 1033
# mk/project.mk gets an absolute path, so we manually include it in
# the bindist with a relative path

Ian Lynagh's avatar
Ian Lynagh committed
1034
BIN_DIST_MK = $(BIN_DIST_PREP_DIR)/bindist.mk
Ian Lynagh's avatar
Ian Lynagh committed
1035

Ian Lynagh's avatar
Ian Lynagh committed
1036
unix-binary-dist-prep:
1037
	$(call removeTrees,bindistprep/)
1038
	"$(MKDIRHIER)" $(BIN_DIST_PREP_DIR)
1039
	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
Ian Lynagh's avatar
Ian Lynagh committed
1040 1041 1042 1043 1044
	echo "HADDOCK_DOCS       = $(HADDOCK_DOCS)"       >> $(BIN_DIST_MK)
	echo "LATEX_DOCS         = $(LATEX_DOCS)"         >> $(BIN_DIST_MK)
	echo "BUILD_DOCBOOK_HTML = $(BUILD_DOCBOOK_HTML)" >> $(BIN_DIST_MK)
	echo "BUILD_DOCBOOK_PS   = $(BUILD_DOCBOOK_PS)"   >> $(BIN_DIST_MK)
	echo "BUILD_DOCBOOK_PDF  = $(BUILD_DOCBOOK_PDF)"  >> $(BIN_DIST_MK)
1045
	echo "BUILD_MAN          = $(BUILD_MAN)"          >> $(BIN_DIST_MK)
1046
	echo "GHC_CABAL_INPLACE  = utils/ghc-cabal/dist-install/build/tmp/ghc-cabal-bindist" >> $(BIN_DIST_MK)
Ian Lynagh's avatar
Ian Lynagh committed
1047
	cd $(BIN_DIST_PREP_DIR) && autoreconf
1048
	$(call removeFiles,$(BIN_DIST_PREP_TAR))
Ian Lynagh's avatar
Ian Lynagh committed
1049 1050
# h means "follow symlinks", e.g. if aclocal.m4 is a symlink to a source
# tree then we want to include the real file, not a symlink to it
1051
	cd bindistprep && "$(TAR_CMD)" hcf - -T ../$(BIN_DIST_LIST) | bzip2 -c > ../$(BIN_DIST_PREP_TAR_BZ2)
1052

Ian Lynagh's avatar
Ian Lynagh committed
1053
windows-binary-dist-prep:
1054
	$(call removeTrees,bindistprep/)
1055
	$(MAKE) prefix=$(TOP)/$(BIN_DIST_PREP_DIR) install
1056
	cd bindistprep && "$(TAR_CMD)" cf - $(BIN_DIST_NAME) | bzip2 -c > ../$(BIN_DIST_PREP_TAR_BZ2)
1057 1058

windows-installer:
1059 1060
ifeq "$(ISCC_CMD)" ""
	@echo No ISCC_CMD, so not making installer
1061
else
1062
	"$(ISCC_CMD)" /O. /Fbindistprep/$(WINDOWS_INSTALLER_BASE) - < distrib/ghc.iss
1063
endif
1064

1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077
# tryTimes tries to run its third argument multiple times, until it
# succeeds. Don't call it directly; call try10Times instead.
# The first and second argument to tryTimes are lists of values.
# The length of the first argument is the number of times we have
# already tried. The length of the second argument is the number more
# times we will try.
tryTimes = $(if $2, \
                { echo 'Try $(words x $1): $3' ; $3 ; } || \
                $(call tryTimes,x $1,$(wordlist 2,$(words $2),$2),$3), \
                )

# Try to run the argument 10 times. If all 10 fail, fail.
try10Times = $(call tryTimes,,x x x x x x x x x x,$1) { echo Failed; false; }
1078 1079 1080

.PHONY: publish-binary-dist
publish-binary-dist:
1081
	$(call try10Times,$(PublishCp) $(BIN_DIST_TAR_BZ2) $(PublishLocation)/dist)
1082
ifeq "$(mingw32_TARGET_OS)" "1"
1083
	$(call try10Times,$(PublishCp) $(WINDOWS_INSTALLER) $(PublishLocation)/dist)
1084
endif
Ian Lynagh's avatar
Ian Lynagh committed
1085

1086
ifeq "$(mingw32_TARGET_OS)" "1"
1087
DOCDIR_TO_PUBLISH = $(BIN_DIST_INST_DIR)/doc
1088
else
1089
DOCDIR_TO_PUBLISH = $(BIN_DIST_INST_DIR)/share/doc/ghc
1090 1091
endif

Ian Lynagh's avatar
Ian Lynagh committed
1092 1093
.PHONY: publish-docs
publish-docs:
1094
	$(call try10Times,$(PublishCp) -r $(DOCDIR_TO_PUBLISH)/* $(PublishLocation)/docs)
Ian Lynagh's avatar
Ian Lynagh committed
1095

Ian Lynagh's avatar
Ian Lynagh committed
1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117
# -----------------------------------------------------------------------------
# Source distributions

# Do it like this:
#
#	$ make
#	$ make sdist
#

# A source dist is built from a complete build tree, because we
# require some extra files not contained in a darcs checkout: the
# output from Happy and Alex, for example.
#
# The steps performed by 'make dist' are as follows:
#   - create a complete link-tree of the current build tree in /tmp
#   - run 'make distclean' on that tree
#   - remove a bunch of other files that we know shouldn't be in the dist
#   - tar up first the extralibs package, then the main source package

#
# Directory in which we're going to build the src dist
#
1118 1119 1120
SRC_DIST_ROOT      = sdistprep
SRC_DIST_BASE_NAME = ghc-$(ProjectVersion)

Ian Lynagh's avatar
Ian Lynagh committed
1121
SRC_DIST_GHC_NAME          = ghc-$(ProjectVersion)-src
1122 1123
SRC_DIST_GHC_ROOT          = $(SRC_DIST_ROOT)/ghc
SRC_DIST_GHC_DIR           = $(SRC_DIST_GHC_ROOT)/$(SRC_DIST_BASE_NAME)
Ian Lynagh's avatar
Ian Lynagh committed
1124
SRC_DIST_GHC_TARBALL       = $(SRC_DIST_ROOT)/$(SRC_DIST_GHC_NAME).tar.bz2
1125

Ian Lynagh's avatar
Ian Lynagh committed
1126
SRC_DIST_TESTSUITE_NAME    = ghc-$(ProjectVersion)-testsuite
1127 1128
SRC_DIST_TESTSUITE_ROOT    = $(SRC_DIST_ROOT)/testsuite-ghc
SRC_DIST_TESTSUITE_DIR     = $(SRC_DIST_TESTSUITE_ROOT)/$(SRC_DIST_BASE_NAME)
Ian Lynagh's avatar
Ian Lynagh committed
1129
SRC_DIST_TESTSUITE_TARBALL = $(SRC_DIST_ROOT)/$(SRC_DIST_TESTSUITE_NAME).tar.bz2
Ian Lynagh's avatar
Ian Lynagh committed
1130 1131 1132 1133

#
# Files to include in source distributions
#
1134 1135 1136 1137 1138 1139 1140
SRC_DIST_GHC_DIRS = mk rules docs distrib bindisttest libffi includes \
    utils docs rts compiler ghc driver libraries ghc-tarballs
SRC_DIST_GHC_FILES += \
    configure.ac config.guess config.sub configure \
    aclocal.m4 README ANNOUNCE HACKING LICENSE Makefile install-sh \
    ghc.spec.in ghc.spec settings.in VERSION \
    boot boot-pkgs packages ghc.mk
Ian Lynagh's avatar
Ian Lynagh committed
1141 1142 1143 1144 1145 1146 1147

VERSION :
	echo $(ProjectVersion) >VERSION

sdist : VERSION

# Use:
1148
#     $(call sdist_ghc_file,compiler,stage2,cmm,Foo/Bar,CmmLex,x)
1149
# to copy the generated file that replaces compiler/cmm/Foo/Bar/CmmLex.x, where
Ian Lynagh's avatar
Ian Lynagh committed
1150
# "stage2" is the dist dir.
1151 1152 1153
define sdist_ghc_file
	"$(CP)" $1/$2/build/$4/$5.hs $(SRC_DIST_GHC_DIR)/$1/$3/$4
	mv $(SRC_DIST_GHC_DIR)/$1/$3/$4/$5.$6 $(SRC_DIST_GHC_DIR)/$1/$3/$4/$5.$6.source
1154
endef
Ian Lynagh's avatar
Ian Lynagh committed
1155

1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184