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 # Suffix rules for Haskell, C and literate
45 include $(TOP)/mk/suffix.mk
47 ##################################################################
48 # GHC standard targets
52 # The depend target has to cope with a set of files that may have
53 # different ways of computing their dependencies, i.e., a Haskell
54 # module's dependencies are computed differently from C files.
56 # Note that we don't compute dependencies automatically, i.e., have the
57 # .depend file be a target that is dependent on the Haskell+C sources,
58 # and then have the `depend' target depend on `.depend'. The reason for
59 # this is that when GNU make is processing the `include .depend' statement
60 # it records .depend as being a Makefile. Before doing any other processing,
61 # `make' will try to check to see if the Makefiles are up-to-date. And,
62 # surprisingly enough, .depend has a rule for it, so if any of the source
63 # files change, it will be invoked, *regardless* of what target you're making.
65 # So, for now, the dependencies has to be re-computed manually via `make depend'
66 # whenever a module changes its set of imports. Doing what was outlined above
67 # is only a small optimisation anyway, it would avoid the recomputation of
68 # dependencies if the .depend file was newer than any of the source modules.
72 # Compiler produced files that are targets of the source's imports.
73 MKDEPENDHS_OBJ_SUFFICES=o
75 ifneq "$(BootingFromHc)" "YES"
76 PKGCONF_DEP = $(STAMP_PKG_CONF)
79 depend :: $(MKDEPENDHS_SRCS) $(MKDEPENDC_SRCS) $(PKGCONF_DEP)
82 ifneq "$(DOC_SRCS)" ""
83 $(MKDEPENDLIT) -o .depend $(MKDEPENDLIT_OPTS) $(filter %.lit,$(DOC_SRCS))
85 ifneq "$(MKDEPENDC_SRCS)" ""
86 $(MKDEPENDC) -f .depend $(MKDEPENDC_OPTS) $(foreach way,$(WAYS),-s $(way)) -- $(CC_OPTS) -- $(MKDEPENDC_SRCS)
88 ifneq "$(MKDEPENDHS_SRCS)" ""
89 $(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)
93 ##################################################################
96 # The boot target, at a minimum generates dependency information
100 ifeq "$(NO_BOOT_TARGET)" "YES"
106 ##################################################################
107 # GNU Standard targets
109 # Every Makefile should define the following targets
112 # Compile the entire program. This should be the default target.
113 # This target need not rebuild any documentation files
116 # Compile the program and copy the executables, libraries, and so on
117 # to the file names where they should reside for actual use. If
118 # there is a simple test to verify that a program is properly
119 # installed, this target should run that test.
121 # The commands should create all the directories in which files are
122 # to be installed, if they don't already exist. This includes the
123 # directories specified as the values of the variables prefix and
124 # exec_prefix , as well as all subdirectories that are needed. One
125 # way to do this is by means of an installdirs target as described
128 # Use `-' before any command for installing a man page, so that make
129 # will ignore any errors. This is in case there are systems that
130 # don't have the Unix man page documentation system installed.
134 # Delete all files from the current directory that are normally
135 # created by building the program. Don't delete the files that
136 # record the configuration. Also preserve files that could be made
137 # by building, but normally aren't because the distribution comes
140 # Delete `.dvi' files here if they are not part of the
144 # Delete all files from the current directory that are created by
145 # configuring or building the program. If you have unpacked the
146 # source and built the program without creating any other files,
147 # `make distclean' should leave only the files that were in the
151 # Like `clean', but may refrain from deleting a few files that
152 # people normally don't want to recompile. For example, the
153 # `mostlyclean' target for GCC does not delete `libgcc.a', because
154 # recompiling it is rarely necessary and takes a lot of time.
157 # Delete everything from the current directory that can be
158 # reconstructed with this Makefile. This typically includes
159 # everything deleted by distclean , plus more: C source files
160 # produced by Bison, tags tables, and so on.
162 # One exception, however: `make maintainer-clean' should not delete
163 # `configure' even if `configure' can be remade using a rule in the
164 # Makefile. More generally, `make maintainer-clean' should not delete
165 # anything that needs to exist in order to run `configure' and then
166 # begin to build the program.
169 # Update a tags table for this program.
171 # `dvi' `ps' `pdf' `html' `chm' `HxS' `rtf'
172 # Generate DVI/PS/PDF files for LaTeX/DocBook docs. Not everything is
173 # supported everywhere, but the intention is to standardise on DocBook
174 # producing all formats.
177 # Perform self-tests (if any). The user must build the program
178 # before running the tests, but need not install the program; you
179 # should write the self-tests so that they work when the program is
180 # built but not installed.
182 # The following targets are suggested as conventional names, for programs
183 # in which they are useful.
186 # Perform installation tests (if any). The user must build and
187 # install the program before running the tests. You should not
188 # assume that `$(bindir)' is in the search path.
191 # It's useful to add a target named `installdirs' to create the
192 # directories where files are installed, and their parent
193 # directories. There is a script called `mkinstalldirs' which is
194 # convenient for this; find it in the Texinfo package.
195 # (GHC: we use a close relative of the suggested script, situated
196 # in glafp-utils/mkdirhier -- SOF)
201 ###########################################
205 ###########################################
207 # For each of these variables that is defined
208 # we generate one "all" rule and one rule for the variable itself:
210 # HS_PROG Haskell program
214 # For details of exactly what rule is generated, see the
215 # relevant section below
219 #----------------------------------------
222 ifneq "$(HS_PROG)" ""
225 ifneq "$(BootingFromHc)" "YES"
226 $(HS_PROG) :: $(OBJS)
227 $(HC) -o $@ $(HC_OPTS) $(LD_OPTS) $(OBJS)
230 $(HS_PROG) :: $(OBJS)
231 $(CC) -o $@ $(HC_BOOT_CC_OPTS) $(HC_BOOT_LD_OPTS) $(OBJS) $(HC_BOOT_LIBS)
235 #----------------------------------------
241 $(C_PROG) :: $(C_OBJS)
242 $(CC) -o $@ $(CC_OPTS) $(LD_OPTS) $(C_OBJS) $(LIBS)
245 #----------------------------------------
248 # Build $(LIBRARY) from $(LIBOBJS)+$(STUBOBJS)
255 # Rule to build $(LIBRARY)
257 ifneq "$(LIBRARY)" ""
263 $(AR) $(AR_OPTS) $@ $(STUBOBJS) $(LIBOBJS)
269 al -out:$@ $(STUBOBJS) $(LIBOBJS)
274 # For Haskell object files, we might have chosen to split
275 # up the object files. Test for whether the library being
276 # built is consisting of Haskell files by (hackily) checking
277 # whether HS_SRCS is empty or not.
280 # can't split objs in way 'u', so we disable it here
285 ifneq "$(HS_SRCS)" ""
286 ifeq "$(SplitObjs)" "YES"
288 SRC_HC_OPTS += -split-objs
290 # We generate the archive into a temporary file libfoo.a.tmp, then
291 # rename it at the end. This avoids the problem that ar may sometimes
292 # fail, leaving a partially built archive behind.
293 ifeq "$(ArSupportsInput)" ""
296 (echo $(STUBOBJS) $(C_OBJS) $(GC_C_OBJS); $(FIND) $(patsubst %.$(way_)o,%_split,$(HS_OBJS)) -name '*.$(way_)o' -print) | xargs $(AR) $@
302 echo $(STUBOBJS) > $@.list
303 echo $(C_OBJS) >> $@.list
304 echo $(GC_C_OBJS) >> $@.list
305 $(FIND) $(patsubst %.$(way_)o,%_split,$(HS_OBJS)) -name '*.$(way_)o' -print >> $@.list
306 $(AR) $(AR_OPTS) $@ $(ArSupportsInput) $@.list
312 # Extra stuff for compiling Haskell files with $(SplitObjs):
315 # If (Haskell) object files are split, cleaning up
316 # consist of descending into the directories where
317 # the myriads of object files have been put.
321 $(FIND) $(patsubst %.$(way_)o,%_split,$(HS_OBJS)) -name '*.$(way_)o' -print -o -name ld.script -print | xargs $(RM) __rm_food
322 -rmdir $(patsubst %.$(way_)o,%_split,$(HS_OBJS)) > /dev/null 2>&1
328 # Remove local symbols from library objects if requested.
331 ifeq "$(StripLibraries)" "YES"
332 ifeq "$(SplitObjs)" "YES"
333 SRC_HC_POST_OPTS += \
334 for i in $(basename $@)_split/*.$(way_)o; do \
335 $(LD) -r $(LD_X) -o $$i.tmp $$i; \
339 SRC_HC_POST_OPTS += \
340 $(LD) -r $(LD_X) -o $@.tmp $@; $(MV) $@.tmp $@
342 endif # StripLibraries
344 # Note: $(STUBOBJS) isn't depended on here, but included when building the lib.
345 # (i.e., the assumption is that $(STUBOBJS) are created as a side-effect
346 # of building $(LIBOBJS)).
347 $(LIBRARY) : $(LIBOBJS)
351 #----------------------------------------
352 # Building Win32 DLLs
355 ifeq "$(DLLized)" "YES"
356 SRC_CC_OPTS += -DDLLized
358 ifneq "$(PACKAGE)" ""
360 SRC_BLD_DLL_OPTS += --export-all --output-def=HS$(PACKAGE)$(_cbits)$(_way).def DllVersionInfo.$(way_)o
362 ifneq "$(PACKAGE) $(IS_CBITS_LIB)" "std YES"
363 ifneq "$(PACKAGE)" "rts"
364 SRC_BLD_DLL_OPTS += -lHSstd_cbits_imp -L$(GHC_LIB_DIR)/std/cbits
365 SRC_BLD_DLL_OPTS += -lHSrts_$(way_)imp -L$(GHC_RTS_DIR)
366 ifneq "$(PACKAGE)" "std"
367 ifeq "$(IS_CBITS_LIB)" ""
368 SRC_BLD_DLL_OPTS += -lHSstd_$(way_)imp -L$(GHC_LIB_DIR)/std
374 SRC_BLD_DLL_OPTS += -lgmp -L. -L$(GHC_RTS_DIR)/gmp
375 ifeq "$(IS_CBITS_LIB)" ""
376 SRC_BLD_DLL_OPTS += $(patsubst %,-lHS%_$(way_)imp, $(PACKAGE_DEPS))
377 SRC_BLD_DLL_OPTS += $(patsubst %,-L../%, $(PACKAGE_DEPS))
379 ifneq "$(HAS_CBITS)" ""
380 SRC_BLD_DLL_OPTS += -lHS$(PACKAGE)_cbits_imp -Lcbits
382 SRC_BLD_DLL_OPTS += -lwsock32 -lwinmm
384 endif # PACKAGE != ""
388 ifneq "$(LIBRARY)" ""
390 all :: DllVersionInfo.$(way_)o
392 ifeq "$(DLL_NAME)" ""
393 DLL_NAME = $(patsubst %.a,%.dll,$(subst lib,,$(LIBRARY)))
396 ifneq "$(DLL_NAME)" ""
397 DLL_NAME := $(DLL_PEN)/$(DLL_NAME)
402 ifeq "$(DLL_IMPLIB_NAME)" ""
403 DLL_IMPLIB_NAME = $(patsubst %.a,%_imp.a,$(LIBRARY))
406 $(DLL_NAME) :: $(LIBRARY)
407 $(BLD_DLL) --output-lib $(DLL_IMPLIB_NAME) -o $(DLL_NAME) $(LIBRARY) $(BLD_DLL_OPTS)
408 endif # LIBRARY != ""
413 # Version information is baked into a DLL by having the DLL include DllVersionInfo.o.
414 # The version info contains two user tweakables: DLL_VERSION and DLL_VERSION_NAME.
415 # (both are given sensible defaults though.)
417 # Note: this will not work as expected with Cygwin B20.1; you need a more recent
418 # version of binutils (to pick up windres bugfixes.)
421 DLL_VERSION=$(ProjectVersion)
424 ifndef DLL_VERSION_NAME
425 DLL_VERSION_NAME="http://www.haskell.org/ghc"
428 ifndef DLL_DESCRIPTION
429 DLL_DESCRIPTION="A GHC-compiled DLL"
433 EXE_VERSION=$(ProjectVersion)
436 ifndef EXE_VERSION_NAME
437 EXE_VERSION_NAME="http://www.haskell.org/ghc"
440 ifndef EXE_DESCRIPTION
441 EXE_DESCRIPTION="A GHC-compiled binary"
445 # Little bit of lo-fi mangling to get at the right set of settings depending
446 # on whether we're generating the VERSIONINFO for a DLL or EXE
448 DLL_OR_EXE=$(subst VersionInfo.$(way_)rc,,$@)
449 VERSION_FT=$(subst Dll, 0x2L, $(subst Exe, 0x1L, $(DLL_OR_EXE)))
450 VERSION_RES_NAME=$(subst Exe,$(EXE_VERSION_NAME), $(subst Dll, $(DLL_VERSION_NAME),$(DLL_OR_EXE)))
451 VERSION_RES=$(subst Exe,$(EXE_VERSION), $(subst Dll, $(DLL_VERSION),$(DLL_OR_EXE)))
452 VERSION_DESC=$(subst Exe,$(EXE_DESCRIPTION), $(subst Dll, $(DLL_DESCRIPTION),$(DLL_OR_EXE)))
454 DllVersionInfo.$(way_)rc ExeVersionInfo.$(way_)rc:
455 $(RM) DllVersionInfo.$(way_)rc
456 echo "1 VERSIONINFO" > $@
457 echo "FILEVERSION 1,0,0,1" >> $@
458 echo "PRODUCTVERSION 1,0,0,1" >> $@
459 echo "FILEFLAGSMASK 0x3fL" >> $@
460 echo "FILEOS 0x4L" >> $@
461 echo "FILETYPE $(VERSION_FT)" >> $@
462 echo "FILESUBTYPE 0x0L" >> $@
464 echo " BLOCK \"StringFileInfo\"" >> $@
466 echo " BLOCK \"040904B0\"" >> $@
468 echo " VALUE \"CompanyName\", \"$(VERSION_RES_NAME)\\0\"" >> $@
469 echo " VALUE \"FileVersion\", \"$(VERSION_RES)\\0\"" >> $@
470 echo " VALUE \"ProductVersion\", \"$(VERSION_RES)\\0\"" >> $@
471 echo " VALUE \"FileDescription\", \"$(VERSION_DESC)\\0\"" >> $@
474 echo " BLOCK \"VarFileInfo\"" >> $@
476 echo " VALUE \"Translation\", 0x0409, 1200" >> $@
480 include $(TOP)/mk/install.mk
482 ##############################################################################
484 # Targets: check tags show
486 ##############################################################################
488 #------------------------------------------------------------
494 @for i in $(filter-out %.lhs .hs, $(TESTS)) ''; do \
495 if (test -f "$$i"); then \
496 echo Running: `basename $$i` ; \
497 cd test; `basename $$i` ; \
501 #------------------------------------------------------------
506 tags TAGS:: $(TAGS_HS_SRCS) $(TAGS_C_SRCS)
509 ifneq "$(TAGS_HS_SRCS)" ""
510 $(HSTAGS) $(HSTAGS_OPTS) $(TAGS_HS_SRCS)
512 ifneq "$(TAGS_C_SRCS)" ""
513 etags -a $(TAGS_C_SRCS)
515 @( 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?
517 #------------------------------------------------------------
519 # to see the effective value used for a Makefile variable, do
520 # make show VALUE=MY_VALUE
524 @echo '$(VALUE)="$($(VALUE))"'
526 ################################################################################
528 # DocBook XML Documentation
530 ################################################################################
532 .PHONY: html html-no-chunks chm HxS fo dvi ps pdf
534 ifneq "$(XML_DOC)" ""
538 # multi-file XML document: main document name is specified in $(XML_DOC),
539 # sub-documents (.xml files) listed in $(XML_SRCS).
541 ifeq "$(XML_SRCS)" ""
542 XML_SRCS = $(wildcard *.xml)
545 XML_HTML = $(addsuffix /index.html,$(basename $(XML_DOC)))
546 XML_HTML_NO_CHUNKS = $(addsuffix .html,$(XML_DOC))
547 XML_CHM = $(addsuffix .chm,$(XML_DOC))
548 XML_HxS = $(addsuffix .HxS,$(XML_DOC))
549 XML_FO = $(addsuffix .fo,$(XML_DOC))
550 XML_DVI = $(addsuffix .dvi,$(XML_DOC))
551 XML_PS = $(addsuffix .ps,$(XML_DOC))
552 XML_PDF = $(addsuffix .pdf,$(XML_DOC))
554 $(XML_HTML) $(XML_NO_CHUNKS_HTML) $(XML_FO) $(XML_DVI) $(XML_PS) $(XML_PDF) :: $(XML_SRCS)
557 html-no-chunks :: $(XML_HTML_NO_CHUNKS)
565 CLEAN_FILES += $(XML_HTML_NO_CHUNKS) $(XML_FO) $(XML_DVI) $(XML_PS) $(XML_PDF)
568 $(RM) -rf $(XML_DOC).out $(FPTOOLS_CSS) $(basename $(XML_DOC)) $(basename $(XML_DOC))-htmlhelp
571 $(XMLLINT) --valid --noout $(XMLLINT_OPTS) $(XML_DOC).xml
574 ##############################################################################
578 ##############################################################################
580 # we have to be careful about recursion here; since all the clean
581 # targets are recursive, we don't want to make eg. distclean depend on
582 # clean because that would result in far too many recursive calls.
584 .PHONY: mostlyclean clean distclean maintainer-clean
587 rm -f $(MOSTLY_CLEAN_FILES)
589 # extraclean is used for adding actions to the clean target.
593 rm -f $(MOSTLY_CLEAN_FILES) $(CLEAN_FILES)
595 distclean:: extraclean
596 rm -f $(MOSTLY_CLEAN_FILES) $(CLEAN_FILES) $(DIST_CLEAN_FILES)
598 maintainer-clean:: extraclean
599 @echo 'This command is intended for maintainers to use; it'
600 @echo 'deletes files that may need special tools to rebuild.'
601 rm -f $(MOSTLY_CLEAN_FILES) $(CLEAN_FILES) $(DIST_CLEAN_FILES) $(MAINTAINER_CLEAN_FILES)
603 ################################################################################
607 ################################################################################
609 # Here is the ingenious jiggery pokery that allows you to build multiple versions
610 # of a program in a single build tree.
612 # The ways setup requires the following variables to be set:
614 # Expects: $(WAYS) the possible "way" strings to one of
615 # which $(way) will be set
618 ifeq "$(findstring $(way), $(WAYS))" ""
619 $(error Unknown way $(way))
623 # So how does $(way) ever get set to anything? Answer, we recursively
624 # invoke make, setting $(way) on the command line.
625 # When do we do this recursion? Answer: whenever the programmer
626 # asks make to make a target that involves a way suffix.
627 # We must remember *not* to recurse again; but that's easy: we
628 # just see if $(way) is set:
632 # If $(WAYS) = p mc, then WAY_TARGETS expands to
633 # %.p_lhs %.p_hs %.p_o ... %.mc_lhs %.p_hs ...
634 # and OTHER_WAY_TARGETS to
635 # %_p.a %_p %_mc.a %_mc
636 # where the suffixes are from $(SUFFIXES)
638 # We have to treat libraries and "other" targets differently,
639 # because their names are of the form
640 # libHS_p.a and Foo_p
641 # whereas everything else has names of the form
644 FPTOOLS_SUFFIXES := o hi hc
646 WAY_TARGETS = $(foreach way,$(WAYS),$(foreach suffix, $(FPTOOLS_SUFFIXES), %.$(way)_$(suffix)))
647 LIB_WAY_TARGETS = $(foreach way,$(WAYS),%_$(way).a %_$(way))
649 # $@ will be something like Foo.p_o
650 # $(suffix $@) returns .p_o
651 # $(subst .,.p_o) returns p_o
652 # $(subst _,.,p_o) returns p.o (clever)
653 # $(basename p.o) returns p
656 $(MAKE) way=$(basename $(subst _,.,$(subst .,,$(suffix $@)))) $@
658 # $(@F) will be something like libHS_p.a, or Foo_p
659 # $(basename $(@F)) will be libHS_p, or Foo_p
660 # The sed script extracts the "p" part.
663 $(MAKE) $(MFLAGS) $@ way=$(subst .,,$(suffix $(subst _,.,$(basename $@))))
667 # -------------------------------------------------------------------------
668 # Object and interface files have suffixes tagged with their ways
671 SRC_HC_OPTS += -hisuf $(way_)hi -hcsuf $(way_)hc -osuf $(way_)o
674 # -------------------------------------------------------------------------
675 # Rules to invoke the current target recursively for each way
677 ifneq "$(strip $(WAYS))" ""
680 # NB: the targets exclude
682 # since these are way-independent
683 all docs TAGS clean distclean mostlyclean maintainer-clean install ::
684 @echo "------------------------------------------------------------------------"
685 @echo "== Recursively making \`$@' for ways: $(WAYS) ..."
686 @echo "PWD = $(shell pwd)"
687 @echo "------------------------------------------------------------------------"
688 # Don't rely on -e working, instead we check exit return codes from sub-makes.
689 case '${MFLAGS}' in *-[ik]*) x_on_err=0;; *-r*[ik]*) x_on_err=0;; *) x_on_err=1;; esac; \
690 for i in $(WAYS) ; do \
691 echo "------------------------------------------------------------------------"; \
692 echo "== $(MAKE) way=$$i $@;"; \
693 echo "PWD = $(shell pwd)"; \
694 echo "------------------------------------------------------------------------"; \
695 $(MAKE) way=$$i --no-print-directory $(MFLAGS) $@ ; \
696 if [ $$? -eq 0 ] ; then true; else exit $$x_on_err; fi; \
698 @echo "------------------------------------------------------------------------"
699 @echo "== Finished recursively making \`$@' for ways: $(WAYS) ..."
700 @echo "PWD = $(shell pwd)"
701 @echo "------------------------------------------------------------------------"
706 include $(TOP)/mk/recurse.mk
708 # -----------------------------------------------------------------------------
711 # Sometimes we want to clean things only after the recursve cleaning
712 # has heppened (eg. if the files we're about to remove would affect
713 # the recursive traversal).
716 rm -f $(LATE_DIST_CLEAN_FILES)
719 rm -f $(LATE_DIST_CLEAN_FILES)