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
44 # NB. needs to be after PRE_SRCS setting above, because otherwise the
45 # rule dependencies won't be set correctly.
47 include $(TOP)/mk/package.mk
49 ###################################################################
50 # Suffix rules for Haskell, C and literate
52 include $(TOP)/mk/suffix.mk
54 ##################################################################
55 # GHC standard targets
59 # The depend target has to cope with a set of files that may have
60 # different ways of computing their dependencies, i.e., a Haskell
61 # module's dependencies are computed differently from C files.
63 # Note that we don't compute dependencies automatically, i.e., have the
64 # .depend file be a target that is dependent on the Haskell+C sources,
65 # and then have the `depend' target depend on `.depend'. The reason for
66 # this is that when GNU make is processing the `include .depend' statement
67 # it records .depend as being a Makefile. Before doing any other processing,
68 # `make' will try to check to see if the Makefiles are up-to-date. And,
69 # surprisingly enough, .depend has a rule for it, so if any of the source
70 # files change, it will be invoked, *regardless* of what target you're making.
72 # So, for now, the dependencies has to be re-computed manually via `make depend'
73 # whenever a module changes its set of imports. Doing what was outlined above
74 # is only a small optimisation anyway, it would avoid the recomputation of
75 # dependencies if the .depend file was newer than any of the source modules.
79 # Compiler produced files that are targets of the source's imports.
80 MKDEPENDHS_OBJ_SUFFICES=o
82 ifneq "$(BootingFromHc)" "YES"
83 PKGCONF_DEP = $(STAMP_PKG_CONF)
86 ifeq "$(USE_NEW_MKDEPEND_FLAGS)" "YES"
87 MKDEPENDHS_FLAGS = -dep-makefile .depend $(foreach way,$(WAYS),-dep-suffix $(way))
89 MKDEPENDHS_FLAGS = -optdep-f -optdep.depend $(foreach way,$(WAYS),-optdep-s -optdep$(way))
92 depend :: $(MKDEPENDHS_SRCS) $(MKDEPENDC_SRCS) $(PKGCONF_DEP)
95 ifneq "$(DOC_SRCS)" ""
96 $(MKDEPENDLIT) -o .depend $(MKDEPENDLIT_OPTS) $(filter %.lit,$(DOC_SRCS))
98 ifneq "$(MKDEPENDC_SRCS)" ""
99 $(MKDEPENDC) -f .depend $(MKDEPENDC_OPTS) $(foreach way,$(WAYS),-s $(way)) -- $(CC_OPTS) -- $(MKDEPENDC_SRCS)
101 ifneq "$(MKDEPENDHS_SRCS)" ""
102 $(MKDEPENDHS) -M $(MKDEPENDHS_FLAGS) $(foreach obj,$(MKDEPENDHS_OBJ_SUFFICES),-osuf $(obj)) $(MKDEPENDHS_OPTS) $(filter-out -split-objs, $(HC_OPTS)) $(MKDEPENDHS_SRCS)
106 ##################################################################
109 # The boot target, at a minimum generates dependency information
113 ifeq "$(NO_BOOT_TARGET)" "YES"
119 ##################################################################
120 # GNU Standard targets
122 # Every Makefile should define the following targets
125 # Compile the entire program. This should be the default target.
126 # This target need not rebuild any documentation files
129 # Compile the program and copy the executables, libraries, and so on
130 # to the file names where they should reside for actual use. If
131 # there is a simple test to verify that a program is properly
132 # installed, this target should run that test.
134 # The commands should create all the directories in which files are
135 # to be installed, if they don't already exist. This includes the
136 # directories specified as the values of the variables prefix and
137 # exec_prefix , as well as all subdirectories that are needed. One
138 # way to do this is by means of an installdirs target as described
141 # Use `-' before any command for installing a man page, so that make
142 # will ignore any errors. This is in case there are systems that
143 # don't have the Unix man page documentation system installed.
147 # Delete all files from the current directory that are normally
148 # created by building the program. Don't delete the files that
149 # record the configuration. Also preserve files that could be made
150 # by building, but normally aren't because the distribution comes
153 # Delete `.dvi' files here if they are not part of the
157 # Delete all files from the current directory that are created by
158 # configuring or building the program. If you have unpacked the
159 # source and built the program without creating any other files,
160 # `make distclean' should leave only the files that were in the
164 # Like `clean', but may refrain from deleting a few files that
165 # people normally don't want to recompile. For example, the
166 # `mostlyclean' target for GCC does not delete `libgcc.a', because
167 # recompiling it is rarely necessary and takes a lot of time.
170 # Delete everything from the current directory that can be
171 # reconstructed with this Makefile. This typically includes
172 # everything deleted by distclean , plus more: C source files
173 # produced by Bison, tags tables, and so on.
175 # One exception, however: `make maintainer-clean' should not delete
176 # `configure' even if `configure' can be remade using a rule in the
177 # Makefile. More generally, `make maintainer-clean' should not delete
178 # anything that needs to exist in order to run `configure' and then
179 # begin to build the program.
182 # Update a tags table for this program.
184 # `dvi' `ps' `pdf' `html' `chm' `HxS' `rtf'
185 # Generate DVI/PS/PDF files for LaTeX/DocBook docs. Not everything is
186 # supported everywhere, but the intention is to standardise on DocBook
187 # producing all formats.
190 # Perform self-tests (if any). The user must build the program
191 # before running the tests, but need not install the program; you
192 # should write the self-tests so that they work when the program is
193 # built but not installed.
195 # The following targets are suggested as conventional names, for programs
196 # in which they are useful.
199 # Perform installation tests (if any). The user must build and
200 # install the program before running the tests. You should not
201 # assume that `$(bindir)' is in the search path.
204 # It's useful to add a target named `installdirs' to create the
205 # directories where files are installed, and their parent
206 # directories. There is a script called `mkinstalldirs' which is
207 # convenient for this; find it in the Texinfo package.
208 # (GHC: we use a close relative of the suggested script, situated
209 # in glafp-utils/mkdirhier -- SOF)
214 ###########################################
218 ###########################################
220 # For each of these variables that is defined
221 # we generate one "all" rule and one rule for the variable itself:
223 # HS_PROG Haskell program
227 # For details of exactly what rule is generated, see the
228 # relevant section below
232 #----------------------------------------
235 ifneq "$(HS_PROG)" ""
238 ifneq "$(BootingFromHc)" "YES"
239 $(HS_PROG) :: $(OBJS)
240 $(HC) -o $@ $(HC_OPTS) $(LD_OPTS) $(OBJS)
243 $(HS_PROG) :: $(OBJS)
244 $(CC) -o $@ $(HC_BOOT_CC_OPTS) $(HC_BOOT_LD_OPTS) $(OBJS) $(HC_BOOT_LIBS)
248 #----------------------------------------
254 $(C_PROG) :: $(C_OBJS)
255 $(CC) -o $@ $(CC_OPTS) $(LD_OPTS) $(C_OBJS) $(LIBS)
258 #----------------------------------------
261 # Build $(LIBRARY) from $(LIBOBJS)+$(STUBOBJS)
268 # Rule to build $(LIBRARY)
270 ifneq "$(LIBRARY)" ""
274 define BUILD_STATIC_LIB
276 $(AR) $(AR_OPTS) $@ $(STUBOBJS) $(LIBOBJS)
280 define BUILD_STATIC_LIB
282 al -out:$@ $(STUBOBJS) $(LIBOBJS)
287 # For Haskell object files, we might have chosen to split
288 # up the object files. Test for whether the library being
289 # built is consisting of Haskell files by (hackily) checking
290 # whether HS_SRCS is empty or not.
293 # can't split objs in way 'u', so we disable it here
298 ifneq "$(HS_SRCS)" ""
299 ifeq "$(SplitObjs)" "YES"
301 SRC_HC_OPTS += -split-objs
303 # We generate the archive into a temporary file libfoo.a.tmp, then
304 # rename it at the end. This avoids the problem that ar may sometimes
305 # fail, leaving a partially built archive behind.
306 ifeq "$(ArSupportsInput)" ""
307 define BUILD_STATIC_LIB
309 (echo $(STUBOBJS) $(C_OBJS) $(GC_C_OBJS); $(FIND) $(patsubst %.$(way_)o,%_split,$(HS_OBJS)) -name '*.$(way_)o' -print) | xargs $(AR) $@
313 define BUILD_STATIC_LIB
315 echo $(STUBOBJS) > $@.list
316 echo $(C_OBJS) >> $@.list
317 echo $(GC_C_OBJS) >> $@.list
318 $(FIND) $(patsubst %.$(way_)o,%_split,$(HS_OBJS)) -name '*.$(way_)o' -print >> $@.list
319 $(AR) $(AR_OPTS) $@ $(ArSupportsInput) $@.list
325 # Extra stuff for compiling Haskell files with $(SplitObjs):
328 # If (Haskell) object files are split, cleaning up
329 # consist of descending into the directories where
330 # the myriads of object files have been put.
334 $(FIND) $(patsubst %.$(way_)o,%_split,$(HS_OBJS)) -name '*.$(way_)o' -print -o -name ld.script -print | xargs $(RM) __rm_food
335 -rmdir $(patsubst %.$(way_)o,%_split,$(HS_OBJS)) > /dev/null 2>&1
341 # Remove local symbols from library objects if requested.
344 ifeq "$(StripLibraries)" "YES"
345 ifeq "$(SplitObjs)" "YES"
346 SRC_HC_POST_OPTS += \
347 for i in $(basename $@)_split/*.$(way_)o; do \
348 $(LD) -r $(LD_X) -o $$i.tmp $$i; \
352 SRC_HC_POST_OPTS += \
353 $(LD) -r $(LD_X) -o $@.tmp $@; $(MV) $@.tmp $@
355 endif # StripLibraries
357 # Note: $(STUBOBJS) isn't depended on here, but included when building the lib.
358 # (i.e., the assumption is that $(STUBOBJS) are created as a side-effect
359 # of building $(LIBOBJS)).
361 ifeq "$(LIBRARY:%.so=YES)" "YES"
363 $(LIBRARY): $(LIBOBJS) $(LIB_DEPS)
365 $(HC) -shared -dynamic -o $@ $(STUBOBJS) $(LIBOBJS) $(LIB_LD_OPTS)
367 ifeq "$(LIBRARY:%.dylib=YES)" "YES"
368 $(LIBRARY): $(LIBOBJS) $(LIB_DEPS)
369 $(HC) -shared -dynamic -o $@ $(STUBOBJS) $(LIBOBJS) $(LIB_LD_OPTS)
371 ifeq "$(LIBRARY:%.dll=YES)" "YES"
372 #----------------------------------------
373 # Building Win32 DLLs
375 $(LIBRARY): $(LIBOBJS) $(LIBRARY).o $(LIB_DEPS)
376 $(HC) -shared -dynamic -o $@ $(STUBOBJS) $(LIBOBJS) $(LIBRARY).o $(LIB_LD_OPTS)
380 $(LIBRARY).def: $(LIBOBJS)
381 $(DLLTOOL) -D $(LIBRARY) --output-def $@ --export-all $(LIBOBJS)
384 $(DLLTOOL) -D $(LIBRARY) --output-exp $(LIBRARY).o $(LIBOBJS)
386 # Generates library.dll.a; by MinGW conventions, this is the dll's import library
387 $(LIBRARY).a: $(LIBOBJS) $(LIBRARY).def
388 $(DLLTOOL) -D $(LIBRARY) --def $(LIBRARY).def --output-lib $@
391 # Version information is baked into a DLL by having the DLL include DllVersionInfo.o.
392 # The version info contains two user tweakables: DLL_VERSION and DLL_VERSION_NAME.
393 # (both are given sensible defaults though.)
395 # Note: this will not work as expected with Cygwin B20.1; you need a more recent
396 # version of binutils (to pick up windres bugfixes.)
399 DLL_VERSION=$(ProjectVersion)
402 ifndef DLL_VERSION_NAME
403 DLL_VERSION_NAME="http://www.haskell.org/ghc"
406 ifndef DLL_DESCRIPTION
407 DLL_DESCRIPTION="A GHC-compiled DLL"
411 EXE_VERSION=$(ProjectVersion)
414 ifndef EXE_VERSION_NAME
415 EXE_VERSION_NAME="http://www.haskell.org/ghc"
418 ifndef EXE_DESCRIPTION
419 EXE_DESCRIPTION="A GHC-compiled binary"
423 # Little bit of lo-fi mangling to get at the right set of settings depending
424 # on whether we're generating the VERSIONINFO for a DLL or EXE
426 DLL_OR_EXE=$(subst VersionInfo.$(way_)rc,,$@)
427 VERSION_FT=$(subst Dll, 0x2L, $(subst Exe, 0x1L, $(DLL_OR_EXE)))
428 VERSION_RES_NAME=$(subst Exe,$(EXE_VERSION_NAME), $(subst Dll, $(DLL_VERSION_NAME),$(DLL_OR_EXE)))
429 VERSION_RES=$(subst Exe,$(EXE_VERSION), $(subst Dll, $(DLL_VERSION),$(DLL_OR_EXE)))
430 VERSION_DESC=$(subst Exe,$(EXE_DESCRIPTION), $(subst Dll, $(DLL_DESCRIPTION),$(DLL_OR_EXE)))
432 DllVersionInfo.$(way_)rc ExeVersionInfo.$(way_)rc:
433 $(RM) DllVersionInfo.$(way_)rc
434 echo "1 VERSIONINFO" > $@
435 echo "FILEVERSION 1,0,0,1" >> $@
436 echo "PRODUCTVERSION 1,0,0,1" >> $@
437 echo "FILEFLAGSMASK 0x3fL" >> $@
438 echo "FILEOS 0x4L" >> $@
439 echo "FILETYPE $(VERSION_FT)" >> $@
440 echo "FILESUBTYPE 0x0L" >> $@
442 echo " BLOCK \"StringFileInfo\"" >> $@
444 echo " BLOCK \"040904B0\"" >> $@
446 echo " VALUE \"CompanyName\", \"$(VERSION_RES_NAME)\\0\"" >> $@
447 echo " VALUE \"FileVersion\", \"$(VERSION_RES)\\0\"" >> $@
448 echo " VALUE \"ProductVersion\", \"$(VERSION_RES)\\0\"" >> $@
449 echo " VALUE \"FileDescription\", \"$(VERSION_DESC)\\0\"" >> $@
452 echo " BLOCK \"VarFileInfo\"" >> $@
454 echo " VALUE \"Translation\", 0x0409, 1200" >> $@
458 # Regular static library
459 $(LIBRARY): $(LIBOBJS)
466 include $(TOP)/mk/install.mk
468 ##############################################################################
470 # Targets: check tags show
472 ##############################################################################
474 #------------------------------------------------------------
480 @for i in $(filter-out %.lhs .hs, $(TESTS)) ''; do \
481 if (test -f "$$i"); then \
482 echo Running: `basename $$i` ; \
483 cd test; `basename $$i` ; \
487 #------------------------------------------------------------
492 tags TAGS:: $(TAGS_HS_SRCS) $(TAGS_C_SRCS)
495 ifneq "$(TAGS_HS_SRCS)" ""
496 $(HSTAGS) $(HSTAGS_OPTS) $(TAGS_HS_SRCS)
498 ifneq "$(TAGS_C_SRCS)" ""
499 etags -a $(TAGS_C_SRCS)
501 @( 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?
503 ################################################################################
505 # DocBook XML Documentation
507 ################################################################################
509 .PHONY: html html-no-chunks chm HxS fo dvi ps pdf
511 ifneq "$(XML_DOC)" ""
515 # multi-file XML document: main document name is specified in $(XML_DOC),
516 # sub-documents (.xml files) listed in $(XML_SRCS).
518 ifeq "$(XML_SRCS)" ""
519 XML_SRCS = $(wildcard *.xml)
522 XML_HTML = $(addsuffix /index.html,$(basename $(XML_DOC)))
523 XML_HTML_NO_CHUNKS = $(addsuffix .html,$(XML_DOC))
524 XML_CHM = $(addsuffix .chm,$(XML_DOC))
525 XML_HxS = $(addsuffix .HxS,$(XML_DOC))
526 XML_FO = $(addsuffix .fo,$(XML_DOC))
527 XML_DVI = $(addsuffix .dvi,$(XML_DOC))
528 XML_PS = $(addsuffix .ps,$(XML_DOC))
529 XML_PDF = $(addsuffix .pdf,$(XML_DOC))
531 $(XML_HTML) $(XML_NO_CHUNKS_HTML) $(XML_FO) $(XML_DVI) $(XML_PS) $(XML_PDF) :: $(XML_SRCS)
534 html-no-chunks :: $(XML_HTML_NO_CHUNKS)
542 CLEAN_FILES += $(XML_HTML_NO_CHUNKS) $(XML_FO) $(XML_DVI) $(XML_PS) $(XML_PDF)
545 $(RM) -rf $(XML_DOC).out $(FPTOOLS_CSS) $(basename $(XML_DOC)) $(basename $(XML_DOC))-htmlhelp
548 $(XMLLINT) --valid --noout $(XMLLINT_OPTS) $(XML_DOC).xml
551 ##############################################################################
555 ##############################################################################
557 # we have to be careful about recursion here; since all the clean
558 # targets are recursive, we don't want to make eg. distclean depend on
559 # clean because that would result in far too many recursive calls.
561 .PHONY: mostlyclean clean distclean maintainer-clean
564 rm -f $(MOSTLY_CLEAN_FILES)
566 # extraclean is used for adding actions to the clean target.
570 rm -f $(MOSTLY_CLEAN_FILES) $(CLEAN_FILES)
572 distclean:: extraclean
573 rm -f $(MOSTLY_CLEAN_FILES) $(CLEAN_FILES) $(DIST_CLEAN_FILES)
575 maintainer-clean:: extraclean
576 @echo 'This command is intended for maintainers to use; it'
577 @echo 'deletes files that may need special tools to rebuild.'
578 rm -f $(MOSTLY_CLEAN_FILES) $(CLEAN_FILES) $(DIST_CLEAN_FILES) $(MAINTAINER_CLEAN_FILES)
580 ################################################################################
584 ################################################################################
586 # Here is the ingenious jiggery pokery that allows you to build multiple versions
587 # of a program in a single build tree.
589 # The ways setup requires the following variables to be set:
591 # Expects: $(WAYS) the possible "way" strings to one of
592 # which $(way) will be set
595 ifeq "$(findstring $(way), $(WAYS))" ""
596 $(error Unknown way $(way) of $(WAYS))
600 # So how does $(way) ever get set to anything? Answer, we recursively
601 # invoke make, setting $(way) on the command line.
602 # When do we do this recursion? Answer: whenever the programmer
603 # asks make to make a target that involves a way suffix.
604 # We must remember *not* to recurse again; but that's easy: we
605 # just see if $(way) is set:
609 # If $(WAYS) = p mc, then WAY_TARGETS expands to
610 # %.p_lhs %.p_hs %.p_o ... %.mc_lhs %.p_hs ...
611 # and OTHER_WAY_TARGETS to
612 # %_p.a %_p %_mc.a %_mc
613 # where the suffixes are from $(SUFFIXES)
615 # We have to treat libraries and "other" targets differently,
616 # because their names are of the form
617 # libHS_p.a and Foo_p
618 # whereas everything else has names of the form
621 FPTOOLS_SUFFIXES := o hi hc
623 WAY_TARGETS = $(foreach way,$(WAYS),$(foreach suffix, $(FPTOOLS_SUFFIXES), %.$(way)_$(suffix)))
624 LIB_WAY_TARGETS = $(foreach way,$(filter-out %dyn,$(WAYS)), %_$(way).a)
625 LIB_WAY_TARGETS_DYN = $(foreach way,$(filter %dyn,$(WAYS)), %$(subst dyn,-ghc$(ProjectVersion),$(subst _dyn,dyn,$(way)))$(soext))
627 # $@ will be something like Foo.p_o
628 # $(suffix $@) returns .p_o
629 # $(subst .,.p_o) returns p_o
630 # $(subst _,.,p_o) returns p.o (clever)
631 # $(basename p.o) returns p
634 $(MAKE) way=$(basename $(subst _,.,$(subst .,,$(suffix $@)))) $@
636 # $(@F) will be something like libHS_p.a, or Foo_p
637 # $(basename $(@F)) will be libHS_p, or Foo_p
638 # The sed script extracts the "p" part.
641 $(MAKE) $(MFLAGS) $@ way=$(subst .,,$(suffix $(subst _,.,$(basename $@))))
643 $(LIB_WAY_TARGETS_DYN) :
644 $(MAKE) $(MFLAGS) $@ way=$(patsubst _dyn,dyn,$(subst .,,$(suffix $(subst _,.,$(basename $(subst -ghc$(ProjectVersion),,$@)))))_dyn)
648 # -------------------------------------------------------------------------
649 # Object and interface files have suffixes tagged with their ways
652 SRC_HC_OPTS += -hisuf $(way_)hi -hcsuf $(way_)hc -osuf $(way_)o
655 # -------------------------------------------------------------------------
656 # Rules to invoke the current target recursively for each way
658 ifneq "$(strip $(WAYS))" ""
661 # NB: the targets exclude
663 # since these are way-independent
664 all docs TAGS clean distclean mostlyclean maintainer-clean install ::
665 @echo "------------------------------------------------------------------------"
666 @echo "== Recursively making \`$@' for ways: $(WAYS) ..."
667 @echo "PWD = $(shell pwd)"
668 @echo "------------------------------------------------------------------------"
669 # Don't rely on -e working, instead we check exit return codes from sub-makes.
670 case '${MFLAGS}' in *-[ik]*) x_on_err=0;; *-r*[ik]*) x_on_err=0;; *) x_on_err=1;; esac; \
671 for i in $(WAYS) ; do \
672 echo "------------------------------------------------------------------------"; \
673 echo "== $(MAKE) way=$$i $@;"; \
674 echo "PWD = $(shell pwd)"; \
675 echo "------------------------------------------------------------------------"; \
676 $(MAKE) way=$$i --no-print-directory $(MFLAGS) $@ ; \
677 if [ $$? -eq 0 ] ; then true; else exit $$x_on_err; fi; \
679 @echo "------------------------------------------------------------------------"
680 @echo "== Finished recursively making \`$@' for ways: $(WAYS) ..."
681 @echo "PWD = $(shell pwd)"
682 @echo "------------------------------------------------------------------------"
687 include $(TOP)/mk/recurse.mk
689 # -----------------------------------------------------------------------------
692 # Sometimes we want to clean things only after the recursve cleaning
693 # has heppened (eg. if the files we're about to remove would affect
694 # the recursive traversal).
697 rm -f $(LATE_DIST_CLEAN_FILES)
700 rm -f $(LATE_DIST_CLEAN_FILES)