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 depend :: $(MKDEPENDHS_SRCS) $(MKDEPENDC_SRCS) $(PKGCONF_DEP)
89 ifneq "$(DOC_SRCS)" ""
90 $(MKDEPENDLIT) -o .depend $(MKDEPENDLIT_OPTS) $(filter %.lit,$(DOC_SRCS))
92 ifneq "$(MKDEPENDC_SRCS)" ""
93 $(MKDEPENDC) -f .depend $(MKDEPENDC_OPTS) $(foreach way,$(WAYS),-s $(way)) -- $(CC_OPTS) -- $(MKDEPENDC_SRCS)
95 ifneq "$(MKDEPENDHS_SRCS)" ""
96 $(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)
100 ##################################################################
103 # The boot target, at a minimum generates dependency information
107 ifeq "$(NO_BOOT_TARGET)" "YES"
113 ##################################################################
114 # GNU Standard targets
116 # Every Makefile should define the following targets
119 # Compile the entire program. This should be the default target.
120 # This target need not rebuild any documentation files
123 # Compile the program and copy the executables, libraries, and so on
124 # to the file names where they should reside for actual use. If
125 # there is a simple test to verify that a program is properly
126 # installed, this target should run that test.
128 # The commands should create all the directories in which files are
129 # to be installed, if they don't already exist. This includes the
130 # directories specified as the values of the variables prefix and
131 # exec_prefix , as well as all subdirectories that are needed. One
132 # way to do this is by means of an installdirs target as described
135 # Use `-' before any command for installing a man page, so that make
136 # will ignore any errors. This is in case there are systems that
137 # don't have the Unix man page documentation system installed.
141 # Delete all files from the current directory that are normally
142 # created by building the program. Don't delete the files that
143 # record the configuration. Also preserve files that could be made
144 # by building, but normally aren't because the distribution comes
147 # Delete `.dvi' files here if they are not part of the
151 # Delete all files from the current directory that are created by
152 # configuring or building the program. If you have unpacked the
153 # source and built the program without creating any other files,
154 # `make distclean' should leave only the files that were in the
158 # Like `clean', but may refrain from deleting a few files that
159 # people normally don't want to recompile. For example, the
160 # `mostlyclean' target for GCC does not delete `libgcc.a', because
161 # recompiling it is rarely necessary and takes a lot of time.
164 # Delete everything from the current directory that can be
165 # reconstructed with this Makefile. This typically includes
166 # everything deleted by distclean , plus more: C source files
167 # produced by Bison, tags tables, and so on.
169 # One exception, however: `make maintainer-clean' should not delete
170 # `configure' even if `configure' can be remade using a rule in the
171 # Makefile. More generally, `make maintainer-clean' should not delete
172 # anything that needs to exist in order to run `configure' and then
173 # begin to build the program.
176 # Update a tags table for this program.
178 # `dvi' `ps' `pdf' `html' `chm' `HxS' `rtf'
179 # Generate DVI/PS/PDF files for LaTeX/DocBook docs. Not everything is
180 # supported everywhere, but the intention is to standardise on DocBook
181 # producing all formats.
184 # Perform self-tests (if any). The user must build the program
185 # before running the tests, but need not install the program; you
186 # should write the self-tests so that they work when the program is
187 # built but not installed.
189 # The following targets are suggested as conventional names, for programs
190 # in which they are useful.
193 # Perform installation tests (if any). The user must build and
194 # install the program before running the tests. You should not
195 # assume that `$(bindir)' is in the search path.
198 # It's useful to add a target named `installdirs' to create the
199 # directories where files are installed, and their parent
200 # directories. There is a script called `mkinstalldirs' which is
201 # convenient for this; find it in the Texinfo package.
202 # (GHC: we use a close relative of the suggested script, situated
203 # in glafp-utils/mkdirhier -- SOF)
208 ###########################################
212 ###########################################
214 # For each of these variables that is defined
215 # we generate one "all" rule and one rule for the variable itself:
217 # HS_PROG Haskell program
221 # For details of exactly what rule is generated, see the
222 # relevant section below
226 #----------------------------------------
229 ifneq "$(HS_PROG)" ""
232 ifneq "$(BootingFromHc)" "YES"
233 $(HS_PROG) :: $(OBJS)
234 $(HC) -o $@ $(HC_OPTS) $(LD_OPTS) $(OBJS)
237 $(HS_PROG) :: $(OBJS)
238 $(CC) -o $@ $(HC_BOOT_CC_OPTS) $(HC_BOOT_LD_OPTS) $(OBJS) $(HC_BOOT_LIBS)
242 #----------------------------------------
248 $(C_PROG) :: $(C_OBJS)
249 $(CC) -o $@ $(CC_OPTS) $(LD_OPTS) $(C_OBJS) $(LIBS)
252 #----------------------------------------
255 # Build $(LIBRARY) from $(LIBOBJS)+$(STUBOBJS)
262 # Rule to build $(LIBRARY)
264 ifneq "$(LIBRARY)" ""
268 define BUILD_STATIC_LIB
270 $(AR) $(AR_OPTS) $@ $(STUBOBJS) $(LIBOBJS)
274 define BUILD_STATIC_LIB
276 al -out:$@ $(STUBOBJS) $(LIBOBJS)
281 # For Haskell object files, we might have chosen to split
282 # up the object files. Test for whether the library being
283 # built is consisting of Haskell files by (hackily) checking
284 # whether HS_SRCS is empty or not.
287 # can't split objs in way 'u', so we disable it here
292 ifneq "$(HS_SRCS)" ""
293 ifeq "$(SplitObjs)" "YES"
295 SRC_HC_OPTS += -split-objs
297 # We generate the archive into a temporary file libfoo.a.tmp, then
298 # rename it at the end. This avoids the problem that ar may sometimes
299 # fail, leaving a partially built archive behind.
300 ifeq "$(ArSupportsInput)" ""
301 define BUILD_STATIC_LIB
303 (echo $(STUBOBJS) $(C_OBJS) $(GC_C_OBJS); $(FIND) $(patsubst %.$(way_)o,%_split,$(HS_OBJS)) -name '*.$(way_)o' -print) | xargs $(AR) $@
307 define BUILD_STATIC_LIB
309 echo $(STUBOBJS) > $@.list
310 echo $(C_OBJS) >> $@.list
311 echo $(GC_C_OBJS) >> $@.list
312 $(FIND) $(patsubst %.$(way_)o,%_split,$(HS_OBJS)) -name '*.$(way_)o' -print >> $@.list
313 $(AR) $(AR_OPTS) $@ $(ArSupportsInput) $@.list
319 # Extra stuff for compiling Haskell files with $(SplitObjs):
322 # If (Haskell) object files are split, cleaning up
323 # consist of descending into the directories where
324 # the myriads of object files have been put.
328 $(FIND) $(patsubst %.$(way_)o,%_split,$(HS_OBJS)) -name '*.$(way_)o' -print -o -name ld.script -print | xargs $(RM) __rm_food
329 -rmdir $(patsubst %.$(way_)o,%_split,$(HS_OBJS)) > /dev/null 2>&1
335 # Remove local symbols from library objects if requested.
338 ifeq "$(StripLibraries)" "YES"
339 ifeq "$(SplitObjs)" "YES"
340 SRC_HC_POST_OPTS += \
341 for i in $(basename $@)_split/*.$(way_)o; do \
342 $(LD) -r $(LD_X) -o $$i.tmp $$i; \
346 SRC_HC_POST_OPTS += \
347 $(LD) -r $(LD_X) -o $@.tmp $@; $(MV) $@.tmp $@
349 endif # StripLibraries
351 # Note: $(STUBOBJS) isn't depended on here, but included when building the lib.
352 # (i.e., the assumption is that $(STUBOBJS) are created as a side-effect
353 # of building $(LIBOBJS)).
355 ifeq "$(LIBRARY:%.so=YES)" "YES"
357 $(LIBRARY): $(LIBOBJS) $(LIB_DEPS)
359 $(HC) -shared -dynamic -o $@ $(STUBOBJS) $(LIBOBJS) $(LIB_LD_OPTS)
361 ifeq "$(LIBRARY:%.dylib=YES)" "YES"
362 $(LIBRARY): $(LIBOBJS) $(LIB_DEPS)
363 $(HC) -shared -dynamic -o $@ $(STUBOBJS) $(LIBOBJS) $(LIB_LD_OPTS)
365 ifeq "$(LIBRARY:%.dll=YES)" "YES"
366 #----------------------------------------
367 # Building Win32 DLLs
369 $(LIBRARY): $(LIBOBJS) $(LIBRARY).o $(LIB_DEPS)
370 $(HC) -shared -dynamic -o $@ $(STUBOBJS) $(LIBOBJS) $(LIBRARY).o $(LIB_LD_OPTS)
374 $(LIBRARY).def: $(LIBOBJS)
375 $(DLLTOOL) --output-def $@ --export-all $(LIBOBJS)
378 $(DLLTOOL) --output-exp $(LIBRARY).o $(LIBOBJS)
380 # Generates library.dll.a; by MinGW conventions, this is the dll's import library
381 $(LIBRARY).a: $(LIBOBJS) $(LIBRARY).def
382 $(DLLTOOL) --def $(LIBRARY).def --output-lib $@
385 # Version information is baked into a DLL by having the DLL include DllVersionInfo.o.
386 # The version info contains two user tweakables: DLL_VERSION and DLL_VERSION_NAME.
387 # (both are given sensible defaults though.)
389 # Note: this will not work as expected with Cygwin B20.1; you need a more recent
390 # version of binutils (to pick up windres bugfixes.)
393 DLL_VERSION=$(ProjectVersion)
396 ifndef DLL_VERSION_NAME
397 DLL_VERSION_NAME="http://www.haskell.org/ghc"
400 ifndef DLL_DESCRIPTION
401 DLL_DESCRIPTION="A GHC-compiled DLL"
405 EXE_VERSION=$(ProjectVersion)
408 ifndef EXE_VERSION_NAME
409 EXE_VERSION_NAME="http://www.haskell.org/ghc"
412 ifndef EXE_DESCRIPTION
413 EXE_DESCRIPTION="A GHC-compiled binary"
417 # Little bit of lo-fi mangling to get at the right set of settings depending
418 # on whether we're generating the VERSIONINFO for a DLL or EXE
420 DLL_OR_EXE=$(subst VersionInfo.$(way_)rc,,$@)
421 VERSION_FT=$(subst Dll, 0x2L, $(subst Exe, 0x1L, $(DLL_OR_EXE)))
422 VERSION_RES_NAME=$(subst Exe,$(EXE_VERSION_NAME), $(subst Dll, $(DLL_VERSION_NAME),$(DLL_OR_EXE)))
423 VERSION_RES=$(subst Exe,$(EXE_VERSION), $(subst Dll, $(DLL_VERSION),$(DLL_OR_EXE)))
424 VERSION_DESC=$(subst Exe,$(EXE_DESCRIPTION), $(subst Dll, $(DLL_DESCRIPTION),$(DLL_OR_EXE)))
426 DllVersionInfo.$(way_)rc ExeVersionInfo.$(way_)rc:
427 $(RM) DllVersionInfo.$(way_)rc
428 echo "1 VERSIONINFO" > $@
429 echo "FILEVERSION 1,0,0,1" >> $@
430 echo "PRODUCTVERSION 1,0,0,1" >> $@
431 echo "FILEFLAGSMASK 0x3fL" >> $@
432 echo "FILEOS 0x4L" >> $@
433 echo "FILETYPE $(VERSION_FT)" >> $@
434 echo "FILESUBTYPE 0x0L" >> $@
436 echo " BLOCK \"StringFileInfo\"" >> $@
438 echo " BLOCK \"040904B0\"" >> $@
440 echo " VALUE \"CompanyName\", \"$(VERSION_RES_NAME)\\0\"" >> $@
441 echo " VALUE \"FileVersion\", \"$(VERSION_RES)\\0\"" >> $@
442 echo " VALUE \"ProductVersion\", \"$(VERSION_RES)\\0\"" >> $@
443 echo " VALUE \"FileDescription\", \"$(VERSION_DESC)\\0\"" >> $@
446 echo " BLOCK \"VarFileInfo\"" >> $@
448 echo " VALUE \"Translation\", 0x0409, 1200" >> $@
452 # Regular static library
453 $(LIBRARY): $(LIBOBJS)
460 include $(TOP)/mk/install.mk
462 ##############################################################################
464 # Targets: check tags show
466 ##############################################################################
468 #------------------------------------------------------------
474 @for i in $(filter-out %.lhs .hs, $(TESTS)) ''; do \
475 if (test -f "$$i"); then \
476 echo Running: `basename $$i` ; \
477 cd test; `basename $$i` ; \
481 #------------------------------------------------------------
486 tags TAGS:: $(TAGS_HS_SRCS) $(TAGS_C_SRCS)
489 ifneq "$(TAGS_HS_SRCS)" ""
490 $(HSTAGS) $(HSTAGS_OPTS) $(TAGS_HS_SRCS)
492 ifneq "$(TAGS_C_SRCS)" ""
493 etags -a $(TAGS_C_SRCS)
495 @( 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?
497 #------------------------------------------------------------
499 # to see the effective value used for a Makefile variable, do
500 # make show VALUE=MY_VALUE
504 @echo '$(VALUE)="$($(VALUE))"'
506 ################################################################################
508 # DocBook XML Documentation
510 ################################################################################
512 .PHONY: html html-no-chunks chm HxS fo dvi ps pdf
514 ifneq "$(XML_DOC)" ""
518 # multi-file XML document: main document name is specified in $(XML_DOC),
519 # sub-documents (.xml files) listed in $(XML_SRCS).
521 ifeq "$(XML_SRCS)" ""
522 XML_SRCS = $(wildcard *.xml)
525 XML_HTML = $(addsuffix /index.html,$(basename $(XML_DOC)))
526 XML_HTML_NO_CHUNKS = $(addsuffix .html,$(XML_DOC))
527 XML_CHM = $(addsuffix .chm,$(XML_DOC))
528 XML_HxS = $(addsuffix .HxS,$(XML_DOC))
529 XML_FO = $(addsuffix .fo,$(XML_DOC))
530 XML_DVI = $(addsuffix .dvi,$(XML_DOC))
531 XML_PS = $(addsuffix .ps,$(XML_DOC))
532 XML_PDF = $(addsuffix .pdf,$(XML_DOC))
534 $(XML_HTML) $(XML_NO_CHUNKS_HTML) $(XML_FO) $(XML_DVI) $(XML_PS) $(XML_PDF) :: $(XML_SRCS)
537 html-no-chunks :: $(XML_HTML_NO_CHUNKS)
545 CLEAN_FILES += $(XML_HTML_NO_CHUNKS) $(XML_FO) $(XML_DVI) $(XML_PS) $(XML_PDF)
548 $(RM) -rf $(XML_DOC).out $(FPTOOLS_CSS) $(basename $(XML_DOC)) $(basename $(XML_DOC))-htmlhelp
551 $(XMLLINT) --valid --noout $(XMLLINT_OPTS) $(XML_DOC).xml
554 ##############################################################################
558 ##############################################################################
560 # we have to be careful about recursion here; since all the clean
561 # targets are recursive, we don't want to make eg. distclean depend on
562 # clean because that would result in far too many recursive calls.
564 .PHONY: mostlyclean clean distclean maintainer-clean
567 rm -f $(MOSTLY_CLEAN_FILES)
569 # extraclean is used for adding actions to the clean target.
573 rm -f $(MOSTLY_CLEAN_FILES) $(CLEAN_FILES)
575 distclean:: extraclean
576 rm -f $(MOSTLY_CLEAN_FILES) $(CLEAN_FILES) $(DIST_CLEAN_FILES)
578 maintainer-clean:: extraclean
579 @echo 'This command is intended for maintainers to use; it'
580 @echo 'deletes files that may need special tools to rebuild.'
581 rm -f $(MOSTLY_CLEAN_FILES) $(CLEAN_FILES) $(DIST_CLEAN_FILES) $(MAINTAINER_CLEAN_FILES)
583 ################################################################################
587 ################################################################################
589 # Here is the ingenious jiggery pokery that allows you to build multiple versions
590 # of a program in a single build tree.
592 # The ways setup requires the following variables to be set:
594 # Expects: $(WAYS) the possible "way" strings to one of
595 # which $(way) will be set
598 ifeq "$(findstring $(way), $(WAYS))" ""
599 $(error Unknown way $(way))
603 # So how does $(way) ever get set to anything? Answer, we recursively
604 # invoke make, setting $(way) on the command line.
605 # When do we do this recursion? Answer: whenever the programmer
606 # asks make to make a target that involves a way suffix.
607 # We must remember *not* to recurse again; but that's easy: we
608 # just see if $(way) is set:
612 # If $(WAYS) = p mc, then WAY_TARGETS expands to
613 # %.p_lhs %.p_hs %.p_o ... %.mc_lhs %.p_hs ...
614 # and OTHER_WAY_TARGETS to
615 # %_p.a %_p %_mc.a %_mc
616 # where the suffixes are from $(SUFFIXES)
618 # We have to treat libraries and "other" targets differently,
619 # because their names are of the form
620 # libHS_p.a and Foo_p
621 # whereas everything else has names of the form
624 FPTOOLS_SUFFIXES := o hi hc
626 WAY_TARGETS = $(foreach way,$(WAYS),$(foreach suffix, $(FPTOOLS_SUFFIXES), %.$(way)_$(suffix)))
627 LIB_WAY_TARGETS = $(foreach way,$(filter-out %dyn,$(WAYS)), %_$(way).a)
628 LIB_WAY_TARGETS_DYN = $(foreach way,$(filter %dyn,$(WAYS)), %$(subst dyn,-ghc$(ProjectVersion),$(subst _dyn,dyn,$(way)))$(soext))
630 # $@ will be something like Foo.p_o
631 # $(suffix $@) returns .p_o
632 # $(subst .,.p_o) returns p_o
633 # $(subst _,.,p_o) returns p.o (clever)
634 # $(basename p.o) returns p
637 $(MAKE) way=$(basename $(subst _,.,$(subst .,,$(suffix $@)))) $@
639 # $(@F) will be something like libHS_p.a, or Foo_p
640 # $(basename $(@F)) will be libHS_p, or Foo_p
641 # The sed script extracts the "p" part.
644 $(MAKE) $(MFLAGS) $@ way=$(subst .,,$(suffix $(subst _,.,$(basename $@))))
646 $(LIB_WAY_TARGETS_DYN) :
647 $(MAKE) $(MFLAGS) $@ way=$(patsubst _dyn,dyn,$(subst .,,$(suffix $(subst _,.,$(basename $(subst -ghc$(ProjectVersion),,$@)))))_dyn)
651 # -------------------------------------------------------------------------
652 # Object and interface files have suffixes tagged with their ways
655 SRC_HC_OPTS += -hisuf $(way_)hi -hcsuf $(way_)hc -osuf $(way_)o
658 # -------------------------------------------------------------------------
659 # Rules to invoke the current target recursively for each way
661 ifneq "$(strip $(WAYS))" ""
664 # NB: the targets exclude
666 # since these are way-independent
667 all docs TAGS clean distclean mostlyclean maintainer-clean install ::
668 @echo "------------------------------------------------------------------------"
669 @echo "== Recursively making \`$@' for ways: $(WAYS) ..."
670 @echo "PWD = $(shell pwd)"
671 @echo "------------------------------------------------------------------------"
672 # Don't rely on -e working, instead we check exit return codes from sub-makes.
673 case '${MFLAGS}' in *-[ik]*) x_on_err=0;; *-r*[ik]*) x_on_err=0;; *) x_on_err=1;; esac; \
674 for i in $(WAYS) ; do \
675 echo "------------------------------------------------------------------------"; \
676 echo "== $(MAKE) way=$$i $@;"; \
677 echo "PWD = $(shell pwd)"; \
678 echo "------------------------------------------------------------------------"; \
679 $(MAKE) way=$$i --no-print-directory $(MFLAGS) $@ ; \
680 if [ $$? -eq 0 ] ; then true; else exit $$x_on_err; fi; \
682 @echo "------------------------------------------------------------------------"
683 @echo "== Finished recursively making \`$@' for ways: $(WAYS) ..."
684 @echo "PWD = $(shell pwd)"
685 @echo "------------------------------------------------------------------------"
690 include $(TOP)/mk/recurse.mk
692 # -----------------------------------------------------------------------------
695 # Sometimes we want to clean things only after the recursve cleaning
696 # has heppened (eg. if the files we're about to remove would affect
697 # the recursive traversal).
700 rm -f $(LATE_DIST_CLEAN_FILES)
703 rm -f $(LATE_DIST_CLEAN_FILES)