28b3d7ce7f2313b9d503d38f9c0e010322236c0b
[ghc-hetmet.git] / mk / target.mk
1 #################################################################################
2 #
3 #                       target.mk
4 #
5 #               Standard targets for fptools
6 #
7 #################################################################################
8
9 #
10 # This file contain three groups of target rules:
11 #
12 # 1.  FPtools targets
13 #       depend*
14 #       runtests*
15 #
16 # 2.  GNU standard targets
17 #       all*
18 #       install* uninstall installcheck installdirs
19 #       clean* distclean* mostlyclean* maintainer-clean*
20 #       tags*
21 #       info dvi ps
22 #       dist binary-dist
23 #       check
24 #
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
28 #
29 #    The recursive targets are marked with a * above
30 #
31
32
33
34 #
35
36
37 ##################################################################
38 #               FPtools standard targets
39 #
40 # depend:
41 #
42 #  The depend target has to cope with a set of files that may have
43 #  different ways of computing their dependencies, i.e., a Haskell
44 #  module's dependencies are computed differently from C files.
45 #
46 # Note that we don't compute dependencies automatically, i.e., have the
47 # .depend file be a target that is dependent on the Haskell+C sources,
48 # and then have the `depend' target depend on `.depend'. The reason for
49 # this is that when GNU make is processing the `include .depend' statement
50 # it records .depend as being a Makefile. Before doing any other processing,
51 # `make' will try to check to see if the Makefiles are up-to-date. And,
52 # surprisingly enough, .depend has a rule for it, so if any of the source
53 # files change, it will be invoked, *regardless* of what target you're making.
54 #
55 # So, for now, the dependencies has to be re-computed manually via `make depend'
56 # whenever a module changes its set of imports. Doing what was outlined above
57 # is only a small optimisation anyway, it would avoid the recomputation of
58 # dependencies if the .depend file was newer than any of the source modules.
59 #
60 .PHONY: depend
61
62 depend :: $(HS_SRCS) $(C_SRCS)
63         @$(RM) .depend
64         @touch .depend
65 ifneq "$(DOC_SRCS)" ""
66         $(MKDEPENDLIT) -o .depend $(MKDEPENDLIT_OPTS) $(filter %.lit,$(DOC_SRCS))
67 endif
68 ifneq "$(C_SRCS)" ""
69         $(MKDEPENDC) -f .depend $(MKDEPENDC_OPTS) -- $(CC_OPTS) -- $(C_SRCS) $(MKDEPENDC_SRCS)
70 endif
71 ifneq "$(HS_SRCS)" ""
72 ifeq ($(notdir $(MKDEPENDHS)),ghc)
73 #       New way of doing dependencies: the ghc driver knows how
74         $(MKDEPENDHS) -M -optdep-f -optdep.depend \
75                 $(foreach way,$(WAYS),-optdep-s -optdep$(way)) \
76                 $(MKDEPENDHS_OPTS) \
77                 $(HC_OPTS) \
78                 $(HS_SRCS)
79 else
80 #       Old way: call mkdependHS-1.2
81         $(MKDEPENDHS) -f .depend $(MKDEPENDHS_OPTS) \
82                 $(foreach way,$(WAYS),-s $(way)) \
83                 -- $(HC_OPTS) -- $(HS_SRCS) $(MKDEPENDHS_SRCS)
84 endif
85 endif
86
87
88 ##################################################################
89 #                       boot
90 #
91 #  The boot target, at a minimum generates dependency information
92
93 .PHONY: boot
94 boot :: depend
95
96
97 ##################################################################
98 #               GNU Standard targets
99 #
100 #       Every Makefile should define the following targets
101
102 # `all'
103 #      Compile the entire program. This should be the default target.
104 #      This target need not rebuild any documentation files; Info files
105 #      should normally be included in the distribution, and DVI files
106 #      should be made only when explicitly asked for.
107
108 # `install'
109 #      Compile the program and copy the executables, libraries, and so on
110 #      to the file names where they should reside for actual use. If
111 #      there is a simple test to verify that a program is properly
112 #      installed, this target should run that test.
113
114 #      The commands should create all the directories in which files are
115 #      to be installed, if they don't already exist. This includes the
116 #      directories specified as the values of the variables prefix and
117 #      exec_prefix , as well as all subdirectories that are needed. One
118 #      way to do this is by means of an installdirs target as described
119 #      below.
120
121 #      Use `-' before any command for installing a man page, so that make
122 #      will ignore any errors.  This is in case there are systems that
123 #      don't have the Unix man page documentation system installed.
124
125 #      The way to install Info files is to copy them into `$(infodir)'
126 #      with $(INSTALL_DATA) (see Command Variables), and then run the
127 #      install-info program if it is present.  install-info is a script
128 #      that edits the Info `dir' file to add or update the menu entry for
129 #      the given Info file; it will be part of the Texinfo package. Here
130 #      is a sample rule to install an Info file:
131
132 #            $(infodir)/foo.info: foo.info # There may be a newer info
133 #            file in . than in srcdir.
134 #                    -if test -f foo.info; then d=.; \
135 #                     else d=$(srcdir); fi; \ $(INSTALL_DATA)
136 #                    $$d/foo.info $@; \ # Run install-info only if it
137 #            exists.  # Use `if' instead of just prepending `-' to the
138 #            # line so we notice real errors from install-info.  # We
139 #            use `$(SHELL) -c' because some shells do not # fail
140 #            gracefully when there is an unknown command.
141 #                    if $(SHELL) -c 'install-info --version' \
142 #                       >/dev/null 2>&1; then \ install-info
143 #                      --infodir=$(infodir) $$d/foo.info; \ else true;
144 #                    fi
145
146 # `uninstall'
147 #      Delete all the installed files that the `install' target would
148 #      create (but not the noninstalled files such as `make all' would
149 #      create).
150
151 # `clean'
152
153 #      Delete all files from the current directory that are normally
154 #      created by building the program.  Don't delete the files that
155 #      record the configuration. Also preserve files that could be made
156 #      by building, but normally aren't because the distribution comes
157 #      with them.
158
159 #      Delete `.dvi' files here if they are not part of the
160 #      distribution.
161
162 # `distclean'
163 #      Delete all files from the current directory that are created by
164 #      configuring or building the program. If you have unpacked the
165 #      source and built the program without creating any other files,
166 #      `make distclean' should leave only the files that were in the
167 #      distribution.
168
169 # `mostlyclean'
170 #      Like `clean', but may refrain from deleting a few files that
171 #      people normally don't want to recompile. For example, the
172 #      `mostlyclean' target for GCC does not delete `libgcc.a', because
173 #      recompiling it is rarely necessary and takes a lot of time.
174
175 # `maintainer-clean'
176 #      Delete everything from the current directory that can be
177 #      reconstructed with this Makefile.  This typically includes
178 #      everything deleted by distclean , plus more: C source files
179 #      produced by Bison, tags tables, Info files, and so on.
180
181 #      One exception, however: `make maintainer-clean' should not delete
182 #      `configure' even if `configure' can be remade using a rule in the
183 #      Makefile. More generally, `make maintainer-clean' should not delete
184 #      anything that needs to exist in order to run `configure' and then
185 #      begin to build the program.
186
187 # `TAGS'
188 #      Update a tags table for this program.
189
190 # `info'
191 #      Generate any Info files needed. The best way to write the rules is
192 #      as follows:
193
194 #            info: foo.info
195
196 #            foo.info: foo.texi chap1.texi chap2.texi
197 #                    $(MAKEINFO) $(srcdir)/foo.texi
198
199 #      You must define the variable MAKEINFO in the Makefile. It should
200 #      run the makeinfo program, which is part of the Texinfo
201 #      distribution.
202
203 # `dvi' `ps'
204 #      Generate DVI files for all TeXinfo documentation. For example:
205
206 #            dvi: foo.dvi
207
208 #            foo.dvi: foo.texi chap1.texi chap2.texi
209 #                    $(TEXI2DVI) $(srcdir)/foo.texi
210
211 #      You must define the variable TEXI2DVI in the Makefile. It should
212 #      run the program texi2dvi , which is part of the Texinfo
213 #      distribution. Alternatively, write just the dependencies, and
214 #      allow GNU Make to provide the command.
215 #
216 #      ps is a FPtools addition for Postscript files
217
218 # `dist' `binary-dist'
219 #      Create a distribution tar file for this program. The tar file
220 #      should be set up so that the file names in the tar file start with
221 #      a subdirectory name which is the name of the package it is a
222 #      distribution for. This name can include the version number.
223
224 #      For example, the distribution tar file of GCC version 1.40 unpacks
225 #      into a subdirectory named `gcc-1.40'.
226
227 #      The easiest way to do this is to create a subdirectory
228 #      appropriately named, use ln or cp to install the proper files in
229 #      it, and then tar that subdirectory.
230
231 #      The dist target should explicitly depend on all non-source files
232 #      that are in the distribution, to make sure they are up to date in
233 #      the distribution. See Making Releases.
234 #
235 #       binary-dist is an FPtools addition for binary distributions
236
237 # `check'
238 #      Perform self-tests (if any). The user must build the program
239 #      before running the tests, but need not install the program; you
240 #      should write the self-tests so that they work when the program is
241 #      built but not installed.
242
243 # The following targets are suggested as conventional names, for programs
244 # in which they are useful.
245
246 # installcheck
247 #      Perform installation tests (if any). The user must build and
248 #      install the program before running the tests. You should not
249 #      assume that `$(bindir)' is in the search path.
250
251 # installdirs
252 #      It's useful to add a target named `installdirs' to create the
253 #      directories where files are installed, and their parent
254 #      directories. There is a script called `mkinstalldirs' which is
255 #      convenient for this; find it in the Texinfo package.
256 #      (FPTOOLS: we don't use the suggested script, but rather the
257 #       mkdirhier script in glafp_utils -- SOF)
258
259
260
261
262 ###########################################
263 #
264 #       Targets: "all"
265 #
266 ###########################################
267
268 # For each of these variables that is defined
269 # we generate one "all" rule and one rule for the variable itself:
270 #
271 #       HS_PROG         Haskell program
272 #       C_PROG          C program
273 #       LIBRARY         Library
274 #       SCRIPT_PROG     Script (e.g. Perl script)
275 #
276 # For details of exactly what rule is generated, see the
277 # relevant section below
278
279 .PHONY: all
280
281 #----------------------------------------
282 #       Haskell programs
283
284 ifneq "$(HS_PROG)" ""
285 all :: $(HS_PROG)
286
287 $(HS_PROG) :: $(HS_OBJS)
288         $(HC) -o $@ $(HC_OPTS) $(LD_OPTS) $(HS_OBJS) $(LIBS)
289 endif
290
291 #----------------------------------------
292 #       C programs
293
294 ifneq "$(C_PROG)" ""
295 all :: $(C_PROG)
296
297 $(C_PROG) :: $(C_OBJS)
298         $(CC) -o $@ $(CC_OPTS) $(LD_OPTS) $(C_OBJS) $(LIBS)
299 endif
300
301
302 #----------------------------------------
303 #       Libraries/archives
304
305 ifneq "$(LIBRARY)" ""
306 all :: $(LIBRARY)
307
308
309 define BUILD_LIB
310 $(RM) $@
311 $(AR) $(AR_OPTS) $@ $(LIBOBJS)
312 $(RANLIB) $@
313 endef
314
315 #
316 # For Haskell object files, we might have chosen to split
317 # up the object files. Test for whether the library being
318 # built is consisting of Haskell files by (hackily) checking
319 # whether HS_SRCS is empty or not.
320 #
321
322 ifneq "$(HS_SRCS)" ""
323 ifneq "$(filter -split-objs,$(HC_OPTS))" ""
324 define BUILD_LIB
325 $(RM) $@
326 TMPDIR=$(TMPDIR); export TMPDIR; find $(patsubst %.$(way_)o,%,$(LIBOBJS)) -name '*.$(way_)o' -print | xargs ar q $@
327 $(RANLIB) $@
328 endef
329 endif # $(filter...
330 endif
331
332 $(LIBRARY) :: $(LIBOBJS)
333         $(BUILD_LIB)
334 endif
335
336 #----------------------------------------
337 #       Script programs
338
339 ifneq "$(SCRIPT_PROG)" ""
340
341 # To produce a fully functional script, you may
342 # have to add some configuration variables at the top of 
343 # the script, i.e., the compiler driver needs to know
344 # the path to various utils in the build tree for instance.
345 #
346 # To have the build rule for the script automatically do this
347 # for you, set the variable SCRIPT_SUBST_VARS to the list of
348 # variables you need to put in.
349
350 #
351 # SCRIPT_SUBST creates a string of echo commands that
352 # will when evaluated append the (perl)variable name and its value 
353 # to the target it is used for, i.e.,
354 #
355 #    A=foo
356 #    B=bar
357 #    SCRIPT_SUBST_VARS = A B
358 #    SCRIPT_SUBST=echo "$""A=\"foo\";" >> $@; echo "$""B=\"bar\";" >> $@
359 #
360 #    so if you have a rule like the following
361 #    
362 #     foo:
363 #         @(RM) $@
364 #         @(TOUCH) $@
365 #         @eval $(SCRIPT_SUBST)
366 #
367 #    `make foo' would create a file `foo' containing the following
368 #
369 #    % cat foo
370 #    $A=foo;
371 #    $B=bar;
372 #    %
373 #
374 # ToDo: make this work for shell scripts (drop the initial $).
375 #
376 SCRIPT_SUBST=$(foreach val,$(SCRIPT_SUBST_VARS),"echo \"$$\"\"$(val)=\\\"$($(val))\\\";\" >> $@;")
377
378 all :: $(SCRIPT_PROG)
379
380 $(SCRIPT_PROG) :: $(SCRIPT_OBJS)
381         $(RM) $@
382         @echo Creating $@...
383 ifneq "$(INTERP)" ""
384         @echo "#!"$(INTERP) > $@
385 else
386         @touch $@
387 endif
388 ifneq "$(SCRIPT_PREFIX_FILES)" ""
389         @cat $(SCRIPT_PREFIX_FILES) >> $@
390 endif
391         @eval $(SCRIPT_SUBST) 
392         @cat $(SCRIPT_OBJS) >> $@
393         @chmod a+x $@
394 endif
395
396
397 ###########################################
398 #
399 #       Targets: install install-strip uninstall
400 #
401 ###########################################
402
403 # For each of these variables that is defined, you
404 # get one install rule
405 #
406 #       INSTALL_PROGS    install these executable programs in $(bindir)
407 #       INSTALL_LIBS     install these platform-dependent libraries in $(libdir)
408 #       INSTALL_LIBEXECS install these platform-dependent execs in $(libdir)
409 #       INSTALL_DATAS    install these platform-independent files in $(datadir)
410 #
411 # If the installation directory variable is undefined, the install rule simply
412 # emits a suitable error message.
413 #
414 # Remember, too, that the installation directory variables ($(bindir) and
415 # friends can be overridden from their original settings in mk/config.mk.in
416 # || mk/build.mk
417 #
418 .PHONY: install installdirs install-strip install-dirs uninstall install-docs
419
420 #
421 # Sometimes useful to separate out the creation of install directories 
422 # from the installation itself.
423 #
424 installdirs ::
425         $(INSTALL_DIR) $(bindir)
426         $(INSTALL_DIR) $(libdir)
427         $(INSTALL_DIR) $(libexecdir)
428         $(INSTALL_DIR) $(datadir)
429
430 # Better do this first...
431 install:: installdirs
432
433 ifneq "$(INSTALL_PROGS)" ""
434 install:: $(INSTALL_PROGS)
435         $(INSTALL_PROGRAM) $(INSTALL_OPTS) $(INSTALL_PROGS) $(bindir)
436 endif
437
438 ifneq "$(INSTALL_LIBS)" ""
439 install:: $(INSTALL_LIBS)
440         $(INSTALL_DATA) $(INSTALL_OPTS) $(INSTALL_LIBS) $(libdir)
441 endif
442
443 ifneq "$(INSTALL_LIBEXECS)" ""
444 install:: $(INSTALL_LIBEXECS)
445         $(INSTALL_PROGRAM) $(INSTALL_OPTS) $(INSTALL_LIBEXECS) $(libexecdir)
446 endif
447
448 ifneq "$(INSTALL_DATAS)" ""
449 install:: $(INSTALL_DATAS)
450         $(INSTALL_DATA) $(INSTALL_OPTS) $(INSTALL_DATAS) $(datadir)
451 endif
452
453 #
454 # Use with care..
455 #
456 uninstall:: 
457 ifeq ($(INSTALL_PROGS),)
458         @for i in $(INSTALL_PROGS) ; do                         \
459                 echo rm -f $(bindir)/`basename $$i`;            \
460                 rm -f $(bindir)/`basename $$i`;                 \
461         done
462 endif
463 ifeq ($(INSTALL_LIBS),)
464         @for i in $(INSTALL_LIBS); do                           \
465                 echo rm -f $(libdir)/`basename $$i`;            \
466                 rm -f $(libdir)/`basename $$i`;                 \
467         done
468 endif
469 ifeq ($(INSTALL_LIBEXECS),)
470         @for i in $(INSTALL_LIBEXECS); do                       \
471                 echo rm -f $(libexecdir)/`basename $$i`;        \
472                 rm -f $(libexecdir)/`basename $$i`;             \
473         done
474 endif
475 ifeq ($(INSTALL_DATAS),)
476         @for i in $(INSTALL_DATAS); do                          \
477                 echo rm -f $(datadir)/`basename $$i`;           \
478                 rm -f $(datadir)/`basename $$i`;                \
479         done
480 endif
481
482 #
483 # install-strip is from the GNU Makefile standard.
484 #
485 ifneq "$(way)" ""
486 install-strip::
487         @$(MAKE) EXTRA_INSTALL_OPTS='-s' install                                        
488 endif
489
490 ###########################################
491 #
492 #       Targets: dist binary-dist
493 #
494 ###########################################
495
496
497 #
498 # dist-pre is a canned rule the toplevel of your source tree
499 # would use as follows, 
500 #
501 #  dist :: dist-pre
502 #
503 # it performs two tasks, first creating the distribution directory
504 # tree and it then decorates the new tree with symbolic links pointing
505 # to the symbolic links in the build tree.
506 #
507 # The dist-pre relies on (at least) the `find' in GNU findutils
508 # (only tested with version 4.1). All non-GNU `find's I have
509 # laid on my hands locally, has a restrictive treatment of {} in
510 # -exec commands, i.e.,
511 #
512 #   find . -print echo a{} \;
513 #   
514 # does not expand the {}, it has to be a separate argument (i.e. `a {}').
515 # GNU find is (IMHO) more sensible here, expanding any {} it comes across
516 # inside an -exec, whether it is a separate argument or part of a word:
517 #
518 #  $ touch yes
519 #  $ find --version
520 #    GNU find version 4.1
521 #  $ find yes -exec echo oh,{}! \;
522 #    oh,yes!
523 #
524 # I'm not claiming that the above is not possible to achieve with
525 # other finds, just that GNU find does the Patently Right Thing here :)
526 #
527 # ====> if you're using these dist rules, get hold of GNU findutils.
528 #
529 #  --SOF 2/97
530 #
531 .PHONY: dist dist-pre dist-post
532
533 dist-pre::
534         -rm -rf $(SRC_DIST_DIR)
535         -rm -f $(SRC_DIST_NAME).tar.gz
536         (cd $(FPTOOLS_TOP_ABS); find $(SRC_DIST_DIRS) -type d \( -name CVS -prune -o -name SRC -prune -o -exec $(MKDIRHIER) $(SRC_DIST_DIR)/{} \; \) ; )
537         (cd $(FPTOOLS_TOP_ABS); find $(SRC_DIST_DIRS) -name CVS -prune -o -name SRC -prune -o -name "*~" -prune -o -name ".cvsignore" -prune -o -type l -exec $(LN_S) $(FPTOOLS_TOP_ABS)/{} $(SRC_DIST_DIR)/{} \; )
538
539 #
540 # After having created a shadow distribution tree and copied/linked
541 # all the necessary files to it, `dist-post' makes sure the permissions
542 # are set right and packages up the tree.
543 #
544 # For now, we make the packaging a separate rule, so as to allow
545 # the inspection of the dist tree before eventually packaging it up.
546 #
547 dist-post::
548         ( cd $(SRC_DIST_DIR) ; cd .. ; chmod -R a+rw $(SRC_DIST_NAME) ) 
549
550 dist-package::
551         cd $(SRC_DIST_DIR); cd ..; $(TAR) chzf $(SRC_DIST_NAME).tar.gz $(SRC_DIST_NAME)
552
553 #
554 # The default dist rule:
555 #
556 # copy/link the contents of $(SRC_DIST_FILES) into the
557 # shadow distribution tree. SRC_DIST_FILES contain the
558 # build-generated files that you want to include in
559 # a source distribution.
560 #
561 #
562 ifneq "$(SRC_DIST_FILES)" ""
563 dist::
564         @for i in $(SRC_DIST_FILES); do                  \
565           if (test -f "$$i"); then                       \
566             echo $(LN_S) `pwd`/$$i $(SRC_DIST_DIR)/$$i ; \
567             $(LN_S) `pwd`/$$i $(SRC_DIST_DIR)/$$i ;      \
568           fi;                                            \
569         done;
570 endif
571
572 #
573 # binary-dist creates a binary bundle, set BIN_DIST_NAME
574 # to package name and do `make binary-dist' (normally this
575 # just a thing you would do from the toplevel of fptools or)
576 # from the top of a project.
577 #
578 .PHONY: binary-dist-pre binary-dist binary-pack
579
580 binary-dist-pre::
581         -rm -rf $(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME)
582         -rm -f $(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME).tar.gz
583         @for i in $(BIN_DIST_DIRS); do                   \
584           if (test -d "$$i"); then                       \
585            echo $(MKDIRHIER) $(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME)/bin/$(TARGETPLATFORM) \
586            $(MKDIRHIER) $(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME)/bin/$(TARGETPLATFORM) \
587            echo $(MKDIRHIER) $(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME)/lib/$(TARGETPLATFORM)/$$i-$(ProjectVersion) \
588            $(MKDIRHIER) $(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME)/lib/$(TARGETPLATFORM)/$$i-$(ProjectVersion) \
589            echo $(MKDIRHIER) $(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME)/share/$$i-$(ProjectVersion) \
590            $(MKDIRHIER) $(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME)/share/$$i-$(ProjectVersion) \
591            echo $(MAKE) -C $$i $(MFLAGS) install BIN_DIST=1 BIN_DIST_NAME=$(BIN_DIST_NAME) prefix=$(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME) exec_prefix=$(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME) bindir=$(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME)/bin/$(TARGETPLATFORM) libdir=$(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME)/lib/$(TARGETPLATFORM)/$$i-$(ProjectVersion) libexecdir=$(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME)/lib/$(TARGETPLATFORM)/$$i-$(ProjectVersion) datadir=$(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME)/share/$$i-$(ProjectVersion); \
592            $(MAKE) -C $$i $(MFLAGS) install BIN_DIST=1 BIN_DIST_NAME=$(BIN_DIST_NAME) prefix=$(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME) exec_prefix=$(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME) bindir=$(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME)/bin/$(TARGETPLATFORM) libdir=$(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME)/lib/$(TARGETPLATFORM)/$$i-$(ProjectVersion) libexecdir=$(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME)/lib/$(TARGETPLATFORM)/$$i-$(ProjectVersion) datadir=$(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME)/share/$$i-$(ProjectVersion); \
593           fi; \
594         done
595
596 #
597 # Do this separately for now
598
599 binary-pack::
600         ( cd $(BIN_DIST_TMPDIR); $(TAR) chzf $(BIN_DIST_NAME).tar.gz $(BIN_DIST_NAME); rm -rf $(BIN_DIST_NAME) )
601
602 ###########################################
603 #
604 #       Targets: check tags show info
605 #
606 ###########################################
607
608 #------------------------------------------------------------
609 #                       Check
610
611 .PHONY: check
612
613 check:: $(TESTS)
614         @for i in $(filter-out %.lhs .hs, $(TESTS)) ''; do      \
615           if (test -f "$$i"); then              \
616             echo Running: `basename $$i` ;      \
617             cd test; `basename $$i` ;           \
618           fi;                                   \
619         done;
620
621 #------------------------------------------------------------
622 #                       Tags
623
624 .PHONY: TAGS
625
626 TAGS:: $(SOURCES)
627         @$(RM) TAGS
628         @touch TAGS
629 ifneq "$(HS_SRCS)" ""
630         $(HSTAGS) $(HSTAGS_OPTS) -- $(HS_SRCS)
631 endif
632 ifneq "$(C_SRCS)" ""
633         etags -a $(C_SRCS)
634 endif
635
636 #------------------------------------------------------------
637 #                       Makefile debugging
638 # to see the effective value used for a Makefile variable, do
639 #  make show VALUE=MY_VALUE
640 #
641
642 show:
643         @echo '$(VALUE)=$($(VALUE))'
644
645 #------------------------------------------------------------
646 #                       Documentation
647
648 .PHONY: dvi ps html info txt
649
650 info:: $(filter %.texinfo, $(DOC_SRCS)) $(filter %.texi,$(DOC_SRCS))
651 dvi:: $(DOC_DVI)
652 ps::  $(DOC_PS)
653 html:: $(DOC_HTML)
654 texi:: $(DOC_TEXI)
655 txt:: $(DOC_TEXT)
656
657 #
658 # Building literate root documents requires extra treatment,
659 # as the root files need to be processed different from other
660 # literate files (`compile' them into .itex with the -S (standalone)
661 # option) and then link together a master TeX document with
662 # a -S option.
663 #
664 $(filter %.tex,$(patsubst %.lit,%.tex,$(DOC_SRCS))) :
665         @$(RM) $@
666         $(LIT2LATEX) -S -c $(LIT2LATEX_OPTS) -o $(patsubst %.tex,%.itex,$@) $(addsuffix .lit,$(basename $@))
667         $(LIT2LATEX) -S $(LIT2LATEX_OPTS) -o $@ $(addsuffix .itex,$(basename $@))
668         @chmod 444 $@
669 #
670 # Ditto for texi and html
671 #
672 $(filter %.texi,$(patsubst %.lit,%.texi,$(DOC_SRCS))) :
673         @$(RM) $@
674         $(LIT2TEXI) -S -c $(LIT2TEXI_OPTS) -o $(patsubst %.texi,%.itxi,$@) $(addsuffix .lit,$(basename $@))
675         $(LIT2TEXI) -S $(LIT2TEXI_OPTS) -o $@ $(addsuffix .itxi,$(basename $@))
676         @chmod 444 $@
677 #
678 # Rather than using lit2html, we opt for the lit-texi-html route,
679 # and use texi2html as our HTML backend.
680 # (Note: we need to change mkdependlit to get this really off the ground)
681 #
682 # If the generated html representation is split up into a myriad of files,
683 # put the files in a subdirectory html/, if a monolith is created, park
684 # the generated file in the same dir as the .lit file.
685 #
686 $(filter %.html,$(patsubst %.lit,%.html,$(DOC_SRCS))) : $(filter %.lit,$(DOC_SRCS))
687         $(RM) $@ $(patsubst %.html,%.texi,$@) $(patsubst %.html,%.itxi,$@)
688 ifneq "$(filter -monolithic,$(TEXI2HTML_OPTS))" ""
689         $(LIT2TEXI) -S -c $(LIT2TEXI_OPTS) -o $(patsubst %.html,%.itxi,$@) $(addsuffix .lit,$(basename $@))
690         $(LIT2TEXI) -S $(LIT2TEXI_OPTS) -o $(patsubst %.html,%.texi,$@) $(addsuffix .itxi,$(basename $@))
691         $(TEXI2HTML) $(TEXI2HTML_OPTS) $(patsubst %.html,%.texi,$@)
692 else
693         $(RM) html/$(basename $@)*
694         $(MKDIRHIER) html
695         $(LIT2TEXI) -S -c $(LIT2TEXI_OPTS) -o $(patsubst %.html,%.itxi,$@) $(addsuffix .lit,$(basename $@))
696         $(LIT2TEXI) -S $(LIT2TEXI_OPTS) -o html/$(patsubst %.html,%.texi,$@) $(addsuffix .itxi,$(basename $@))
697         (cd html; ../$(TEXI2HTML) $(TEXI2HTML_OPTS) $(patsubst %.html,%.texi,$@); cd ..)
698         @touch $@
699 endif
700
701 ###########################################
702 #
703 #       Targets: clean
704 #
705 ###########################################
706
707 .PHONY: realclean mostlyclean clean distclean maintainer-clean
708
709 # realclean is just a synonym for maintainer-clean
710 realclean: maintainer-clean
711
712
713 ifneq "$(MOSTLY_CLEAN_FILES)" ""
714 mostlyclean::
715         rm -f $(MOSTLY_CLEAN_FILES)
716 endif
717
718 ifneq "$(CLEAN_FILES)" ""
719 clean:: mostlyclean
720         rm -f $(CLEAN_FILES)
721 endif
722
723
724 ifneq "$(DIST_CLEAN_FILES)" ""
725 distclean:: mostlyclean clean
726         rm -f $(DIST_CLEAN_FILES)
727 endif
728
729
730 ifneq "$(MAINTAINER_CLEAN_FILES)" ""
731 maintainer-clean:: mostlyclean clean distclean
732         @echo 'This command is intended for maintainers to use; it'
733         @echo 'deletes files that may need special tools to rebuild.'
734         rm -f $(MAINTAINER_CLEAN_FILES)
735 endif
736
737 #
738 # If (Haskell) object files are split, cleaning up 
739 # consist of descending into the directories where
740 # the myriads of object files have been put.
741 #
742
743 ifneq "$(HS_OBJS)" ""
744 ifneq "$(filter -split-objs,$(HC_OPTS))" ""
745 clean ::
746         find $(patsubst %.$(way_)o,%,$(HS_OBJS)) -name '*.$(way_)o' -print | xargs $(RM) __rm_food;
747 endif
748 endif
749
750
751 #################################################################################
752 #
753 #                       Way management
754 #
755 #################################################################################
756
757 # Here is the ingenious jiggery pokery that allows you to build multiple versions
758 # of a program in a single build tree.
759 #
760 # The ways setup requires the following variables to be set:
761 #
762 # Expects:      $(WAYS)                 the possible "way" strings to one of 
763 #                                       which $(way) will be set
764
765
766 # So how does $(way) ever get set to anything?  Answer, we recursively
767 # invoke make, setting $(way) on the command line.
768 # When do we do this recursion?  Answer: whenever the programmer
769 # asks make to make a target that involves a way suffix.
770 # We must remember *not* to recurse again; but that's easy: we
771 # just see if $(way) is set:
772
773 ifeq "$(way)" ""
774
775 # If $(WAYS) = p mc, then WAY_TARGETS expands to
776 #       %.p_lhs %.p_hs %.p_o ... %.mc_lhs %.p_hs ...
777 # and OTHER_WAY_TARGETS to
778 #       %_p.a %_p %_mc.a %_mc
779 # where the suffixes are from $(SUFFIXES)
780 #
781 # We have to treat libraries and "other" targets differently, 
782 # because their names are of the form
783 #       libHS_p.a and Foo_p
784 # whereas everything else has names of the form
785 #       Foo.p_o
786
787 FPTOOLS_SUFFIXES := o hi hc
788
789 WAY_TARGETS     = $(foreach way,$(WAYS),$(foreach suffix, $(FPTOOLS_SUFFIXES), %.$(way)_$(suffix)))
790 LIB_WAY_TARGETS = $(foreach way,$(WAYS),%_$(way).a %_$(way))
791
792 # $@ will be something like Foo.p_o
793 # $(suffix $@) will be .p_o
794 # The sed script extracts the "p" part.
795
796 $(WAY_TARGETS) :
797         $(MAKE) way=$(basename $(subst _,.,$(subst .,,$(suffix $@)))) $@
798
799 # $(@F) will be something like libHS_p.a, or Foo_p
800 # $(basename $(@F)) will be libHS_p, or Foo_p
801 # The sed script extracts the "p" part.
802
803 $(LIB_WAY_TARGETS) :
804         $(MAKE) $(MFLAGS) $@ way=$(subst .,,$(suffix $(subst _,.,$(basename $@))))
805
806 endif   # if way
807
808
809 ##################################################################
810 #
811 #               Recursive stuff
812 #
813 ##################################################################
814
815 # Here are the diabolically clever rules that
816
817 # (a) for each "recursive target" <t>
818 #     propagates "make <t>" to directories in SUBDIRS
819 #
820 # (b) when SUBDIRS is empty,
821 #     for each "multi-way-target" <t>
822 #     calls "make -way=w <t>" for each w in $(WAYS)
823 #
824 #     This has the effect of making the standard target
825 #     in each of the specified ways (as well as in the normal way
826
827 # Controlling variables
828 #       WAYS    = extra (beyond the normal way) ways to build things in
829 #       SUBDIRS = subdirectories to recurse into
830
831 # No ways, so iterate over the SUBDIRS
832
833 ifeq "$(way)" ""
834 ifneq "$(SUBDIRS)" ""
835
836 all docs runtests boot TAGS clean veryclean maintainer-clean install info ::
837         @case '${MFLAGS}' in *[ik]*) set +e;; esac; \
838         for i in $(SUBDIRS) ; do \
839           $(MAKE) -C $$i $(MFLAGS) $@; \
840         done
841
842 dist ::
843         @case '${MFLAGS}' in *[ik]*) set +e;; esac; \
844         for i in $(SUBDIRS) ; do \
845           $(MKDIRHIER_PREFIX)mkdirhier $(SRC_DIST_DIR)/$$i; \
846           $(MAKE) -C $$i $(MFLAGS) $@ SRC_DIST_DIR=$(SRC_DIST_DIR)/$$i; \
847         done
848 endif
849 endif
850
851 #
852 # Selectively building subdirectories.
853 #
854 #
855 ifneq "$(SUBDIRS)" ""
856 $(SUBDIRS) ::
857           $(MAKE) -C $@ $(MFLAGS)
858 endif
859
860 ifneq "$(WAYS)" ""
861 ifeq "$(way)" ""
862
863 # NB: the targets exclude 
864 #       boot info TAGS
865 # since these are way-independent
866 all docs runtests TAGS clean veryclean maintainer-clean install ::
867         for i in $(WAYS) ; do \
868           $(MAKE) way=$$i $(MFLAGS) $@ ; \
869         done
870
871 endif
872 endif
873