1 #################################################################################
5 # Standard targets for GHC
7 #################################################################################
10 # This file contain three groups of target rules:
16 # 2. GNU standard targets
18 # install* installcheck installdirs
20 # clean* distclean* mostlyclean* maintainer-clean*
22 # dvi ps (no info) GHC adds: pdf rtf html chm HxS
25 # 3. Some of the above targets have a version that
26 # recursively invokes that target in sub-directories.
27 # This relies on the importing Makefile setting SUBDIRS
29 # The recursive targets are marked with a * above
36 ##################################################################
37 # Pre-compute the list of sources so we don't have to do this
38 # multiple times. See paths.mk.
40 PRE_SRCS := $(ALL_SRCS)
42 ##################################################################
43 # Include package building machinery
45 include $(TOP)/mk/package.mk
47 ###################################################################
48 # Suffix rules for Haskell, C and literate
50 include $(TOP)/mk/suffix.mk
52 ##################################################################
53 # GHC standard targets
57 # The depend target has to cope with a set of files that may have
58 # different ways of computing their dependencies, i.e., a Haskell
59 # module's dependencies are computed differently from C files.
61 # Note that we don't compute dependencies automatically, i.e., have the
62 # .depend file be a target that is dependent on the Haskell+C sources,
63 # and then have the `depend' target depend on `.depend'. The reason for
64 # this is that when GNU make is processing the `include .depend' statement
65 # it records .depend as being a Makefile. Before doing any other processing,
66 # `make' will try to check to see if the Makefiles are up-to-date. And,
67 # surprisingly enough, .depend has a rule for it, so if any of the source
68 # files change, it will be invoked, *regardless* of what target you're making.
70 # So, for now, the dependencies has to be re-computed manually via `make depend'
71 # whenever a module changes its set of imports. Doing what was outlined above
72 # is only a small optimisation anyway, it would avoid the recomputation of
73 # dependencies if the .depend file was newer than any of the source modules.
77 # Compiler produced files that are targets of the source's imports.
78 MKDEPENDHS_OBJ_SUFFICES=o
80 ifneq "$(BootingFromHc)" "YES"
81 PKGCONF_DEP = $(STAMP_PKG_CONF)
84 depend :: $(MKDEPENDHS_SRCS) $(MKDEPENDC_SRCS) $(PKGCONF_DEP)
87 ifneq "$(DOC_SRCS)" ""
88 $(MKDEPENDLIT) -o .depend $(MKDEPENDLIT_OPTS) $(filter %.lit,$(DOC_SRCS))
90 ifneq "$(MKDEPENDC_SRCS)" ""
91 $(MKDEPENDC) -f .depend $(MKDEPENDC_OPTS) $(foreach way,$(WAYS),-s $(way)) -- $(CC_OPTS) -- $(MKDEPENDC_SRCS)
93 ifneq "$(MKDEPENDHS_SRCS)" ""
94 $(MKDEPENDHS) -M -optdep-f -optdep.depend $(foreach way,$(WAYS),-optdep-s -optdep$(way)) $(foreach obj,$(MKDEPENDHS_OBJ_SUFFICES),-osuf $(obj)) $(MKDEPENDHS_OPTS) $(filter-out -split-objs, $(HC_OPTS)) $(MKDEPENDHS_SRCS)
98 ##################################################################
101 # The boot target, at a minimum generates dependency information
105 ifeq "$(NO_BOOT_TARGET)" "YES"
111 ##################################################################
112 # GNU Standard targets
114 # Every Makefile should define the following targets
117 # Compile the entire program. This should be the default target.
118 # This target need not rebuild any documentation files
121 # Compile the program and copy the executables, libraries, and so on
122 # to the file names where they should reside for actual use. If
123 # there is a simple test to verify that a program is properly
124 # installed, this target should run that test.
126 # The commands should create all the directories in which files are
127 # to be installed, if they don't already exist. This includes the
128 # directories specified as the values of the variables prefix and
129 # exec_prefix , as well as all subdirectories that are needed. One
130 # way to do this is by means of an installdirs target as described
133 # Use `-' before any command for installing a man page, so that make
134 # will ignore any errors. This is in case there are systems that
135 # don't have the Unix man page documentation system installed.
139 # Delete all files from the current directory that are normally
140 # created by building the program. Don't delete the files that
141 # record the configuration. Also preserve files that could be made
142 # by building, but normally aren't because the distribution comes
145 # Delete `.dvi' files here if they are not part of the
149 # Delete all files from the current directory that are created by
150 # configuring or building the program. If you have unpacked the
151 # source and built the program without creating any other files,
152 # `make distclean' should leave only the files that were in the
156 # Like `clean', but may refrain from deleting a few files that
157 # people normally don't want to recompile. For example, the
158 # `mostlyclean' target for GCC does not delete `libgcc.a', because
159 # recompiling it is rarely necessary and takes a lot of time.
162 # Delete everything from the current directory that can be
163 # reconstructed with this Makefile. This typically includes
164 # everything deleted by distclean , plus more: C source files
165 # produced by Bison, tags tables, and so on.
167 # One exception, however: `make maintainer-clean' should not delete
168 # `configure' even if `configure' can be remade using a rule in the
169 # Makefile. More generally, `make maintainer-clean' should not delete
170 # anything that needs to exist in order to run `configure' and then
171 # begin to build the program.
174 # Update a tags table for this program.
176 # `dvi' `ps' `pdf' `html' `chm' `HxS' `rtf'
177 # Generate DVI/PS/PDF files for LaTeX/DocBook docs. Not everything is
178 # supported everywhere, but the intention is to standardise on DocBook
179 # producing all formats.
182 # Perform self-tests (if any). The user must build the program
183 # before running the tests, but need not install the program; you
184 # should write the self-tests so that they work when the program is
185 # built but not installed.
187 # The following targets are suggested as conventional names, for programs
188 # in which they are useful.
191 # Perform installation tests (if any). The user must build and
192 # install the program before running the tests. You should not
193 # assume that `$(bindir)' is in the search path.
196 # It's useful to add a target named `installdirs' to create the
197 # directories where files are installed, and their parent
198 # directories. There is a script called `mkinstalldirs' which is
199 # convenient for this; find it in the Texinfo package.
200 # (GHC: we use a close relative of the suggested script, situated
201 # in glafp-utils/mkdirhier -- SOF)
206 ###########################################
210 ###########################################
212 # For each of these variables that is defined
213 # we generate one "all" rule and one rule for the variable itself:
215 # HS_PROG Haskell program
219 # For details of exactly what rule is generated, see the
220 # relevant section below
224 #----------------------------------------
227 ifneq "$(HS_PROG)" ""
230 ifneq "$(BootingFromHc)" "YES"
231 $(HS_PROG) :: $(OBJS)
232 $(HC) -o $@ $(HC_OPTS) $(LD_OPTS) $(OBJS)
235 $(HS_PROG) :: $(OBJS)
236 $(CC) -o $@ $(HC_BOOT_CC_OPTS) $(HC_BOOT_LD_OPTS) $(OBJS) $(HC_BOOT_LIBS)
240 #----------------------------------------
246 $(C_PROG) :: $(C_OBJS)
247 $(CC) -o $@ $(CC_OPTS) $(LD_OPTS) $(C_OBJS) $(LIBS)
250 #----------------------------------------
253 # Build $(LIBRARY) from $(LIBOBJS)+$(STUBOBJS)
260 # Rule to build $(LIBRARY)
262 ifneq "$(LIBRARY)" ""
268 $(AR) $(AR_OPTS) $@ $(STUBOBJS) $(LIBOBJS)
274 al -out:$@ $(STUBOBJS) $(LIBOBJS)
279 # For Haskell object files, we might have chosen to split
280 # up the object files. Test for whether the library being
281 # built is consisting of Haskell files by (hackily) checking
282 # whether HS_SRCS is empty or not.
285 # can't split objs in way 'u', so we disable it here
290 ifneq "$(HS_SRCS)" ""
291 ifeq "$(SplitObjs)" "YES"
293 SRC_HC_OPTS += -split-objs
295 # We generate the archive into a temporary file libfoo.a.tmp, then
296 # rename it at the end. This avoids the problem that ar may sometimes
297 # fail, leaving a partially built archive behind.
298 ifeq "$(ArSupportsInput)" ""
301 (echo $(STUBOBJS) $(C_OBJS) $(GC_C_OBJS); $(FIND) $(patsubst %.$(way_)o,%_split,$(HS_OBJS)) -name '*.$(way_)o' -print) | xargs $(AR) $@
307 echo $(STUBOBJS) > $@.list
308 echo $(C_OBJS) >> $@.list
309 echo $(GC_C_OBJS) >> $@.list
310 $(FIND) $(patsubst %.$(way_)o,%_split,$(HS_OBJS)) -name '*.$(way_)o' -print >> $@.list
311 $(AR) $(AR_OPTS) $@ $(ArSupportsInput) $@.list
317 # Extra stuff for compiling Haskell files with $(SplitObjs):
320 # If (Haskell) object files are split, cleaning up
321 # consist of descending into the directories where
322 # the myriads of object files have been put.
326 $(FIND) $(patsubst %.$(way_)o,%_split,$(HS_OBJS)) -name '*.$(way_)o' -print -o -name ld.script -print | xargs $(RM) __rm_food
327 -rmdir $(patsubst %.$(way_)o,%_split,$(HS_OBJS)) > /dev/null 2>&1
333 # Remove local symbols from library objects if requested.
336 ifeq "$(StripLibraries)" "YES"
337 ifeq "$(SplitObjs)" "YES"
338 SRC_HC_POST_OPTS += \
339 for i in $(basename $@)_split/*.$(way_)o; do \
340 $(LD) -r $(LD_X) -o $$i.tmp $$i; \
344 SRC_HC_POST_OPTS += \
345 $(LD) -r $(LD_X) -o $@.tmp $@; $(MV) $@.tmp $@
347 endif # StripLibraries
349 # Note: $(STUBOBJS) isn't depended on here, but included when building the lib.
350 # (i.e., the assumption is that $(STUBOBJS) are created as a side-effect
351 # of building $(LIBOBJS)).
352 $(LIBRARY) : $(LIBOBJS)
356 #----------------------------------------
357 # Building Win32 DLLs
360 ifeq "$(DLLized)" "YES"
361 SRC_CC_OPTS += -DDLLized
363 ifneq "$(PACKAGE)" ""
365 SRC_BLD_DLL_OPTS += --export-all --output-def=HS$(PACKAGE)$(_cbits)$(_way).def DllVersionInfo.$(way_)o
367 ifneq "$(PACKAGE) $(IS_CBITS_LIB)" "std YES"
368 ifneq "$(PACKAGE)" "rts"
369 SRC_BLD_DLL_OPTS += -lHSstd_cbits_imp -L$(GHC_LIB_DIR)/std/cbits
370 SRC_BLD_DLL_OPTS += -lHSrts_$(way_)imp -L$(GHC_RTS_DIR)
371 ifneq "$(PACKAGE)" "std"
372 ifeq "$(IS_CBITS_LIB)" ""
373 SRC_BLD_DLL_OPTS += -lHSstd_$(way_)imp -L$(GHC_LIB_DIR)/std
379 SRC_BLD_DLL_OPTS += -lgmp -L. -L$(GHC_RTS_DIR)/gmp
380 ifeq "$(IS_CBITS_LIB)" ""
381 SRC_BLD_DLL_OPTS += $(patsubst %,-lHS%_$(way_)imp, $(PACKAGE_DEPS))
382 SRC_BLD_DLL_OPTS += $(patsubst %,-L../%, $(PACKAGE_DEPS))
384 ifneq "$(HAS_CBITS)" ""
385 SRC_BLD_DLL_OPTS += -lHS$(PACKAGE)_cbits_imp -Lcbits
387 SRC_BLD_DLL_OPTS += -lwsock32 -lwinmm
389 endif # PACKAGE != ""
393 ifneq "$(LIBRARY)" ""
395 all :: DllVersionInfo.$(way_)o
397 ifeq "$(DLL_NAME)" ""
398 DLL_NAME = $(patsubst %.a,%.dll,$(subst lib,,$(LIBRARY)))
401 ifneq "$(DLL_NAME)" ""
402 DLL_NAME := $(DLL_PEN)/$(DLL_NAME)
407 ifeq "$(DLL_IMPLIB_NAME)" ""
408 DLL_IMPLIB_NAME = $(patsubst %.a,%_imp.a,$(LIBRARY))
411 $(DLL_NAME) :: $(LIBRARY)
412 $(BLD_DLL) --output-lib $(DLL_IMPLIB_NAME) -o $(DLL_NAME) $(LIBRARY) $(BLD_DLL_OPTS)
413 endif # LIBRARY != ""
418 # Version information is baked into a DLL by having the DLL include DllVersionInfo.o.
419 # The version info contains two user tweakables: DLL_VERSION and DLL_VERSION_NAME.
420 # (both are given sensible defaults though.)
422 # Note: this will not work as expected with Cygwin B20.1; you need a more recent
423 # version of binutils (to pick up windres bugfixes.)
426 DLL_VERSION=$(ProjectVersion)
429 ifndef DLL_VERSION_NAME
430 DLL_VERSION_NAME="http://www.haskell.org/ghc"
433 ifndef DLL_DESCRIPTION
434 DLL_DESCRIPTION="A GHC-compiled DLL"
438 EXE_VERSION=$(ProjectVersion)
441 ifndef EXE_VERSION_NAME
442 EXE_VERSION_NAME="http://www.haskell.org/ghc"
445 ifndef EXE_DESCRIPTION
446 EXE_DESCRIPTION="A GHC-compiled binary"
450 # Little bit of lo-fi mangling to get at the right set of settings depending
451 # on whether we're generating the VERSIONINFO for a DLL or EXE
453 DLL_OR_EXE=$(subst VersionInfo.$(way_)rc,,$@)
454 VERSION_FT=$(subst Dll, 0x2L, $(subst Exe, 0x1L, $(DLL_OR_EXE)))
455 VERSION_RES_NAME=$(subst Exe,$(EXE_VERSION_NAME), $(subst Dll, $(DLL_VERSION_NAME),$(DLL_OR_EXE)))
456 VERSION_RES=$(subst Exe,$(EXE_VERSION), $(subst Dll, $(DLL_VERSION),$(DLL_OR_EXE)))
457 VERSION_DESC=$(subst Exe,$(EXE_DESCRIPTION), $(subst Dll, $(DLL_DESCRIPTION),$(DLL_OR_EXE)))
459 DllVersionInfo.$(way_)rc ExeVersionInfo.$(way_)rc:
460 $(RM) DllVersionInfo.$(way_)rc
461 echo "1 VERSIONINFO" > $@
462 echo "FILEVERSION 1,0,0,1" >> $@
463 echo "PRODUCTVERSION 1,0,0,1" >> $@
464 echo "FILEFLAGSMASK 0x3fL" >> $@
465 echo "FILEOS 0x4L" >> $@
466 echo "FILETYPE $(VERSION_FT)" >> $@
467 echo "FILESUBTYPE 0x0L" >> $@
469 echo " BLOCK \"StringFileInfo\"" >> $@
471 echo " BLOCK \"040904B0\"" >> $@
473 echo " VALUE \"CompanyName\", \"$(VERSION_RES_NAME)\\0\"" >> $@
474 echo " VALUE \"FileVersion\", \"$(VERSION_RES)\\0\"" >> $@
475 echo " VALUE \"ProductVersion\", \"$(VERSION_RES)\\0\"" >> $@
476 echo " VALUE \"FileDescription\", \"$(VERSION_DESC)\\0\"" >> $@
479 echo " BLOCK \"VarFileInfo\"" >> $@
481 echo " VALUE \"Translation\", 0x0409, 1200" >> $@
485 include $(TOP)/mk/install.mk
487 ##############################################################################
489 # Targets: check tags show
491 ##############################################################################
493 #------------------------------------------------------------
499 @for i in $(filter-out %.lhs .hs, $(TESTS)) ''; do \
500 if (test -f "$$i"); then \
501 echo Running: `basename $$i` ; \
502 cd test; `basename $$i` ; \
506 #------------------------------------------------------------
511 tags TAGS:: $(TAGS_HS_SRCS) $(TAGS_C_SRCS)
514 ifneq "$(TAGS_HS_SRCS)" ""
515 $(HSTAGS) $(HSTAGS_OPTS) $(TAGS_HS_SRCS)
517 ifneq "$(TAGS_C_SRCS)" ""
518 etags -a $(TAGS_C_SRCS)
520 @( DEREFFED=`ls -l Makefile | sed -e 's/.*-> \(.*\)/\1/g'` && $(RM) `dirname $$DEREFFED`/TAGS && $(CP) TAGS `dirname $$DEREFFED` ) 2>/dev/null || echo TAGS file generated, perhaps copy over to source tree?
522 #------------------------------------------------------------
524 # to see the effective value used for a Makefile variable, do
525 # make show VALUE=MY_VALUE
529 @echo '$(VALUE)="$($(VALUE))"'
531 ################################################################################
533 # DocBook XML Documentation
535 ################################################################################
537 .PHONY: html html-no-chunks chm HxS fo dvi ps pdf
539 ifneq "$(XML_DOC)" ""
543 # multi-file XML document: main document name is specified in $(XML_DOC),
544 # sub-documents (.xml files) listed in $(XML_SRCS).
546 ifeq "$(XML_SRCS)" ""
547 XML_SRCS = $(wildcard *.xml)
550 XML_HTML = $(addsuffix /index.html,$(basename $(XML_DOC)))
551 XML_HTML_NO_CHUNKS = $(addsuffix .html,$(XML_DOC))
552 XML_CHM = $(addsuffix .chm,$(XML_DOC))
553 XML_HxS = $(addsuffix .HxS,$(XML_DOC))
554 XML_FO = $(addsuffix .fo,$(XML_DOC))
555 XML_DVI = $(addsuffix .dvi,$(XML_DOC))
556 XML_PS = $(addsuffix .ps,$(XML_DOC))
557 XML_PDF = $(addsuffix .pdf,$(XML_DOC))
559 $(XML_HTML) $(XML_NO_CHUNKS_HTML) $(XML_FO) $(XML_DVI) $(XML_PS) $(XML_PDF) :: $(XML_SRCS)
562 html-no-chunks :: $(XML_HTML_NO_CHUNKS)
570 CLEAN_FILES += $(XML_HTML_NO_CHUNKS) $(XML_FO) $(XML_DVI) $(XML_PS) $(XML_PDF)
573 $(RM) -rf $(XML_DOC).out $(FPTOOLS_CSS) $(basename $(XML_DOC)) $(basename $(XML_DOC))-htmlhelp
576 $(XMLLINT) --valid --noout $(XMLLINT_OPTS) $(XML_DOC).xml
579 ##############################################################################
583 ##############################################################################
585 # we have to be careful about recursion here; since all the clean
586 # targets are recursive, we don't want to make eg. distclean depend on
587 # clean because that would result in far too many recursive calls.
589 .PHONY: mostlyclean clean distclean maintainer-clean
592 rm -f $(MOSTLY_CLEAN_FILES)
594 # extraclean is used for adding actions to the clean target.
598 rm -f $(MOSTLY_CLEAN_FILES) $(CLEAN_FILES)
600 distclean:: extraclean
601 rm -f $(MOSTLY_CLEAN_FILES) $(CLEAN_FILES) $(DIST_CLEAN_FILES)
603 maintainer-clean:: extraclean
604 @echo 'This command is intended for maintainers to use; it'
605 @echo 'deletes files that may need special tools to rebuild.'
606 rm -f $(MOSTLY_CLEAN_FILES) $(CLEAN_FILES) $(DIST_CLEAN_FILES) $(MAINTAINER_CLEAN_FILES)
608 ################################################################################
612 ################################################################################
614 # Here is the ingenious jiggery pokery that allows you to build multiple versions
615 # of a program in a single build tree.
617 # The ways setup requires the following variables to be set:
619 # Expects: $(WAYS) the possible "way" strings to one of
620 # which $(way) will be set
623 ifeq "$(findstring $(way), $(WAYS))" ""
624 $(error Unknown way $(way))
628 # So how does $(way) ever get set to anything? Answer, we recursively
629 # invoke make, setting $(way) on the command line.
630 # When do we do this recursion? Answer: whenever the programmer
631 # asks make to make a target that involves a way suffix.
632 # We must remember *not* to recurse again; but that's easy: we
633 # just see if $(way) is set:
637 # If $(WAYS) = p mc, then WAY_TARGETS expands to
638 # %.p_lhs %.p_hs %.p_o ... %.mc_lhs %.p_hs ...
639 # and OTHER_WAY_TARGETS to
640 # %_p.a %_p %_mc.a %_mc
641 # where the suffixes are from $(SUFFIXES)
643 # We have to treat libraries and "other" targets differently,
644 # because their names are of the form
645 # libHS_p.a and Foo_p
646 # whereas everything else has names of the form
649 FPTOOLS_SUFFIXES := o hi hc
651 WAY_TARGETS = $(foreach way,$(WAYS),$(foreach suffix, $(FPTOOLS_SUFFIXES), %.$(way)_$(suffix)))
652 LIB_WAY_TARGETS = $(foreach way,$(WAYS),%_$(way).a %_$(way))
654 # $@ will be something like Foo.p_o
655 # $(suffix $@) returns .p_o
656 # $(subst .,.p_o) returns p_o
657 # $(subst _,.,p_o) returns p.o (clever)
658 # $(basename p.o) returns p
661 $(MAKE) way=$(basename $(subst _,.,$(subst .,,$(suffix $@)))) $@
663 # $(@F) will be something like libHS_p.a, or Foo_p
664 # $(basename $(@F)) will be libHS_p, or Foo_p
665 # The sed script extracts the "p" part.
668 $(MAKE) $(MFLAGS) $@ way=$(subst .,,$(suffix $(subst _,.,$(basename $@))))
672 # -------------------------------------------------------------------------
673 # Object and interface files have suffixes tagged with their ways
676 SRC_HC_OPTS += -hisuf $(way_)hi -hcsuf $(way_)hc -osuf $(way_)o
679 # -------------------------------------------------------------------------
680 # Rules to invoke the current target recursively for each way
682 ifneq "$(strip $(WAYS))" ""
685 # NB: the targets exclude
687 # since these are way-independent
688 all docs TAGS clean distclean mostlyclean maintainer-clean install ::
689 @echo "------------------------------------------------------------------------"
690 @echo "== Recursively making \`$@' for ways: $(WAYS) ..."
691 @echo "PWD = $(shell pwd)"
692 @echo "------------------------------------------------------------------------"
693 # Don't rely on -e working, instead we check exit return codes from sub-makes.
694 case '${MFLAGS}' in *-[ik]*) x_on_err=0;; *-r*[ik]*) x_on_err=0;; *) x_on_err=1;; esac; \
695 for i in $(WAYS) ; do \
696 echo "------------------------------------------------------------------------"; \
697 echo "== $(MAKE) way=$$i $@;"; \
698 echo "PWD = $(shell pwd)"; \
699 echo "------------------------------------------------------------------------"; \
700 $(MAKE) way=$$i --no-print-directory $(MFLAGS) $@ ; \
701 if [ $$? -eq 0 ] ; then true; else exit $$x_on_err; fi; \
703 @echo "------------------------------------------------------------------------"
704 @echo "== Finished recursively making \`$@' for ways: $(WAYS) ..."
705 @echo "PWD = $(shell pwd)"
706 @echo "------------------------------------------------------------------------"
711 include $(TOP)/mk/recurse.mk
713 # -----------------------------------------------------------------------------
716 # Sometimes we want to clean things only after the recursve cleaning
717 # has heppened (eg. if the files we're about to remove would affect
718 # the recursive traversal).
721 rm -f $(LATE_DIST_CLEAN_FILES)
724 rm -f $(LATE_DIST_CLEAN_FILES)