[project @ 1998-01-30 17:07:42 by simonm]
[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 # Compiler produced files that are targets of the source's imports.
63 MKDEPENDHS_OBJ_SUFFICES=o
64
65 depend :: $(MKDEPENDHS_SRCS) $(MKDEPENDC_SRCS)
66         @$(RM) .depend
67         @touch .depend
68 ifneq "$(DOC_SRCS)" ""
69         $(MKDEPENDLIT) -o .depend $(MKDEPENDLIT_OPTS) $(filter %.lit,$(DOC_SRCS))
70 endif
71 ifneq "$(MKDEPENDC_SRCS)" ""
72         $(MKDEPENDC) -f .depend $(MKDEPENDC_OPTS) -- $(CC_OPTS) -- $(MKDEPENDC_SRCS)
73 endif
74 ifneq "$(MKDEPENDHS_SRCS)" ""
75         $(MKDEPENDHS) -M -optdep-f -optdep.depend $(foreach way,$(WAYS),-optdep-s -optdep$(way)) $(foreach obj,$(MKDEPENDHS_OBJ_SUFFICES),-optdep-o -optdep$(obj)) $(MKDEPENDHS_OPTS) $(patsubst -odir,,$(HC_OPTS)) $(MKDEPENDHS_SRCS)
76 endif
77
78 # the above patsubst is a hack to remove the '-odir $*' from HC_OPTS
79 # which is present when we're splitting objects.  The $* maps to
80 # nothing, since this isn't a pattern rule, so we have to get rid of
81 # the -odir too to avoid problems.
82
83 ##################################################################
84 #                       boot
85 #
86 #  The boot target, at a minimum generates dependency information
87
88 .PHONY: boot
89 boot :: depend
90
91
92 ##################################################################
93 #               GNU Standard targets
94 #
95 #       Every Makefile should define the following targets
96
97 # `all'
98 #      Compile the entire program. This should be the default target.
99 #      This target need not rebuild any documentation files; Info files
100 #      should normally be included in the distribution, and DVI files
101 #      should be made only when explicitly asked for.
102
103 # `install'
104 #      Compile the program and copy the executables, libraries, and so on
105 #      to the file names where they should reside for actual use. If
106 #      there is a simple test to verify that a program is properly
107 #      installed, this target should run that test.
108
109 #      The commands should create all the directories in which files are
110 #      to be installed, if they don't already exist. This includes the
111 #      directories specified as the values of the variables prefix and
112 #      exec_prefix , as well as all subdirectories that are needed. One
113 #      way to do this is by means of an installdirs target as described
114 #      below.
115
116 #      Use `-' before any command for installing a man page, so that make
117 #      will ignore any errors.  This is in case there are systems that
118 #      don't have the Unix man page documentation system installed.
119
120 #      The way to install Info files is to copy them into `$(infodir)'
121 #      with $(INSTALL_DATA) (see Command Variables), and then run the
122 #      install-info program if it is present.  install-info is a script
123 #      that edits the Info `dir' file to add or update the menu entry for
124 #      the given Info file; it will be part of the Texinfo package. Here
125 #      is a sample rule to install an Info file:
126
127 #            $(infodir)/foo.info: foo.info # There may be a newer info
128 #            file in . than in srcdir.
129 #                    -if test -f foo.info; then d=.; \
130 #                     else d=$(srcdir); fi; \ $(INSTALL_DATA)
131 #                    $$d/foo.info $@; \ # Run install-info only if it
132 #            exists.  # Use `if' instead of just prepending `-' to the
133 #            # line so we notice real errors from install-info.  # We
134 #            use `$(SHELL) -c' because some shells do not # fail
135 #            gracefully when there is an unknown command.
136 #                    if $(SHELL) -c 'install-info --version' \
137 #                       >/dev/null 2>&1; then \ install-info
138 #                      --infodir=$(infodir) $$d/foo.info; \ else true;
139 #                    fi
140
141 # `uninstall'
142 #      Delete all the installed files that the `install' target would
143 #      create (but not the noninstalled files such as `make all' would
144 #      create).
145
146 # `clean'
147
148 #      Delete all files from the current directory that are normally
149 #      created by building the program.  Don't delete the files that
150 #      record the configuration. Also preserve files that could be made
151 #      by building, but normally aren't because the distribution comes
152 #      with them.
153
154 #      Delete `.dvi' files here if they are not part of the
155 #      distribution.
156
157 # `distclean'
158 #      Delete all files from the current directory that are created by
159 #      configuring or building the program. If you have unpacked the
160 #      source and built the program without creating any other files,
161 #      `make distclean' should leave only the files that were in the
162 #      distribution.
163
164 # `mostlyclean'
165 #      Like `clean', but may refrain from deleting a few files that
166 #      people normally don't want to recompile. For example, the
167 #      `mostlyclean' target for GCC does not delete `libgcc.a', because
168 #      recompiling it is rarely necessary and takes a lot of time.
169
170 # `maintainer-clean'
171 #      Delete everything from the current directory that can be
172 #      reconstructed with this Makefile.  This typically includes
173 #      everything deleted by distclean , plus more: C source files
174 #      produced by Bison, tags tables, Info files, and so on.
175
176 #      One exception, however: `make maintainer-clean' should not delete
177 #      `configure' even if `configure' can be remade using a rule in the
178 #      Makefile. More generally, `make maintainer-clean' should not delete
179 #      anything that needs to exist in order to run `configure' and then
180 #      begin to build the program.
181
182 # `TAGS'
183 #      Update a tags table for this program.
184
185 # `info'
186 #      Generate any Info files needed. The best way to write the rules is
187 #      as follows:
188
189 #            info: foo.info
190
191 #            foo.info: foo.texi chap1.texi chap2.texi
192 #                    $(MAKEINFO) $(srcdir)/foo.texi
193
194 #      You must define the variable MAKEINFO in the Makefile. It should
195 #      run the makeinfo program, which is part of the Texinfo
196 #      distribution.
197
198 # `dvi' `ps'
199 #      Generate DVI files for all TeXinfo documentation. For example:
200
201 #            dvi: foo.dvi
202
203 #            foo.dvi: foo.texi chap1.texi chap2.texi
204 #                    $(TEXI2DVI) $(srcdir)/foo.texi
205
206 #      You must define the variable TEXI2DVI in the Makefile. It should
207 #      run the program texi2dvi , which is part of the Texinfo
208 #      distribution. Alternatively, write just the dependencies, and
209 #      allow GNU Make to provide the command.
210 #
211 #      ps is a FPtools addition for Postscript files
212
213 # `dist' `binary-dist'
214 #      Create a distribution tar file for this program. The tar file
215 #      should be set up so that the file names in the tar file start with
216 #      a subdirectory name which is the name of the package it is a
217 #      distribution for. This name can include the version number.
218
219 #      For example, the distribution tar file of GCC version 1.40 unpacks
220 #      into a subdirectory named `gcc-1.40'.
221
222 #      The easiest way to do this is to create a subdirectory
223 #      appropriately named, use ln or cp to install the proper files in
224 #      it, and then tar that subdirectory.
225
226 #      The dist target should explicitly depend on all non-source files
227 #      that are in the distribution, to make sure they are up to date in
228 #      the distribution. See Making Releases.
229 #
230 #       binary-dist is an FPtools addition for binary distributions
231
232 # `check'
233 #      Perform self-tests (if any). The user must build the program
234 #      before running the tests, but need not install the program; you
235 #      should write the self-tests so that they work when the program is
236 #      built but not installed.
237
238 # The following targets are suggested as conventional names, for programs
239 # in which they are useful.
240
241 # installcheck
242 #      Perform installation tests (if any). The user must build and
243 #      install the program before running the tests. You should not
244 #      assume that `$(bindir)' is in the search path.
245
246 # installdirs
247 #      It's useful to add a target named `installdirs' to create the
248 #      directories where files are installed, and their parent
249 #      directories. There is a script called `mkinstalldirs' which is
250 #      convenient for this; find it in the Texinfo package.
251 #      (FPTOOLS: we use a close relative of the suggested script, situated
252 #       in glafp-utils/mkdirhier -- SOF)
253
254
255
256
257 ###########################################
258 #
259 #       Targets: "all"
260 #
261 ###########################################
262
263 # For each of these variables that is defined
264 # we generate one "all" rule and one rule for the variable itself:
265 #
266 #       HS_PROG         Haskell program
267 #       C_PROG          C program
268 #       LIBRARY         Library
269 #       SCRIPT_PROG     Script (e.g. Perl script)
270 #
271 # For details of exactly what rule is generated, see the
272 # relevant section below
273
274 .PHONY: all
275
276 #----------------------------------------
277 #       Haskell programs
278
279 ifneq "$(HS_PROG)" ""
280 all :: $(HS_PROG)
281
282 $(HS_PROG) :: $(HS_OBJS)
283         $(HC) -o $@ $(HC_OPTS) $(LD_OPTS) $(HS_OBJS) $(LIBS)
284 endif
285
286 #----------------------------------------
287 #       C programs
288
289 ifneq "$(C_PROG)" ""
290 all :: $(C_PROG)
291
292 $(C_PROG) :: $(C_OBJS)
293         $(CC) -o $@ $(CC_OPTS) $(LD_OPTS) $(C_OBJS) $(LIBS)
294 endif
295
296
297 #----------------------------------------
298 #       Libraries/archives
299
300 ifneq "$(LIBRARY)" ""
301 all :: $(LIBRARY)
302
303
304 define BUILD_LIB
305 $(RM) $@
306 $(AR) $(AR_OPTS) $@ $(LIBOBJS)
307 $(RANLIB) $@
308 endef
309
310 #
311 # For Haskell object files, we might have chosen to split
312 # up the object files. Test for whether the library being
313 # built is consisting of Haskell files by (hackily) checking
314 # whether HS_SRCS is empty or not.
315 #
316
317 ifneq "$(HS_SRCS)" ""
318 ifneq "$(filter -split-objs,$(HC_OPTS))" ""
319 define BUILD_LIB
320 $(RM) $@
321 TMPDIR=$(TMPDIR); export TMPDIR; find $(patsubst %.$(way_)o,%,$(LIBOBJS)) -name '*.$(way_)o' -print | xargs ar q $@
322 $(RANLIB) $@
323 endef
324 endif # $(filter...
325 endif
326
327 $(LIBRARY) :: $(LIBOBJS)
328         $(BUILD_LIB)
329 endif
330
331 #----------------------------------------
332 #       Script programs
333
334 ifneq "$(SCRIPT_PROG)" ""
335
336 # To produce a fully functional script, you may
337 # have to add some configuration variables at the top of 
338 # the script, i.e., the compiler driver needs to know
339 # the path to various utils in the build tree for instance.
340 #
341 # To have the build rule for the script automatically do this
342 # for you, set the variable SCRIPT_SUBST_VARS to the list of
343 # variables you need to put in.
344
345 #
346 # SCRIPT_SUBST creates a string of echo commands that
347 # will when evaluated append the (perl)variable name and its value 
348 # to the target it is used for, i.e.,
349 #
350 #    A=foo
351 #    B=bar
352 #    SCRIPT_SUBST_VARS = A B
353 #    SCRIPT_SUBST=echo "$""A=\"foo\";" >> $@; echo "$""B=\"bar\";" >> $@
354 #
355 #    so if you have a rule like the following
356 #    
357 #     foo:
358 #         @(RM) $@
359 #         @(TOUCH) $@
360 #         @eval $(SCRIPT_SUBST)
361 #
362 #    `make foo' would create a file `foo' containing the following
363 #
364 #    % cat foo
365 #    $A=foo;
366 #    $B=bar;
367 #    %
368 #
369 # ToDo: make this work for shell scripts (drop the initial $).
370 #
371 ifeq "$(INTERP)" "$(SHELL)"
372 SCRIPT_SUBST=$(foreach val,$(SCRIPT_SUBST_VARS),"echo \"$(val)=\\\"$($(val))\\\";\" >> $@;")
373 else
374 SCRIPT_SUBST=$(foreach val,$(SCRIPT_SUBST_VARS),"echo \"$$\"\"$(val)=\\\"$($(val))\\\";\" >> $@;")
375 endif
376
377 all :: $(SCRIPT_PROG)
378
379 #
380 # #! support under cygwin32 is not quite there yet, 
381 # so we rely on the eval `trick' instead. On all other
382 # platforms, we prepend #!$(INTERP)  -- SOF 6/97
383
384
385 $(SCRIPT_PROG) :: $(SCRIPT_OBJS)
386         $(RM) $@
387         @echo Creating $@...
388 ifeq "$(INTERP)" "perl"
389 ifneq "$(BIN_DIST)" "1"
390         echo "#! "$(PERL) > $@
391 else
392         @touch $@
393 endif
394 else
395 ifneq "$(INTERP)" ""
396         @echo "#!"$(INTERP) > $@
397 else
398         @touch $@
399 endif
400 endif
401 ifneq "$(SCRIPT_PREFIX_FILES)" ""
402         @cat $(SCRIPT_PREFIX_FILES) >> $@
403 endif
404         @eval $(SCRIPT_SUBST) 
405         @cat $(SCRIPT_OBJS) >> $@
406         @chmod a+x $@
407         @echo Done.
408 endif
409
410
411 ###########################################
412 #
413 #       Targets: install install-strip uninstall
414 #
415 ###########################################
416
417 # For each of these variables that is defined, you
418 # get one install rule
419 #
420 #       INSTALL_PROGS     executable programs in $(bindir)
421 #       INSTALL_SCRIPTS   executable scripts in $(bindir)
422 #       INSTALL_LIBS      platform-dependent libraries in $(libdir) (ranlib'ed)
423 #       INSTALL_LIBEXECS  platform-dependent execs in $(libdir)
424 #       INSTALL_DATAS     platform-independent files in $(datadir)
425 #
426 # If the installation directory variable is undefined, the install rule simply
427 # emits a suitable error message.
428 #
429 # Remember, too, that the installation directory variables ($(bindir) and
430 # friends can be overridden from their original settings in mk/config.mk.in
431 # || mk/build.mk
432 #
433 .PHONY: install installdirs install-strip install-dirs uninstall install-docs show-install
434
435 show-install :
436         @echo "bindir = $(bindir)"
437         @echo "libdir = $(libdir)"
438         @echo "libexecdir = $(libexecdir)  # by default, same as libdir"
439         @echo "datadir = $(datadir)  # unused for ghc project"
440
441 #
442 # Sometimes useful to separate out the creation of install directories 
443 # from the installation itself.
444 #
445 install-dirs ::
446         @$(INSTALL_DIR) $(bindir)
447         @$(INSTALL_DIR) $(libdir)
448         @$(INSTALL_DIR) $(libexecdir)
449         @$(INSTALL_DIR) $(datadir)
450
451 # Better do this first...
452 # but we won't for the moment, do it on-demand from
453 # within the various install targets instead.
454 #install:: install-dirs
455
456 ifneq "$(INSTALL_PROGS)" ""
457 install:: $(INSTALL_PROGS)
458         @$(INSTALL_DIR) $(bindir)
459         for i in $(INSTALL_PROGS); do \
460                 $(INSTALL_PROGRAM) $(INSTALL_BIN_OPTS) $$i$(exeext) $(bindir); \
461         done
462 endif
463
464 #
465 # Just like INSTALL_PROGS, but prefix with install sites bin/lib/data and
466 # install without stripping.
467 #
468 ifneq "$(INSTALL_SCRIPTS)" ""
469 install:: $(INSTALL_SCRIPTS)
470         @$(INSTALL_DIR) $(bindir)
471 ifeq "$(INTERP)" "perl"
472 ifneq "$(BIN_DIST)" "1"
473         @for i in $(INSTALL_SCRIPTS); do \
474            $(RM) $$i.tmp; \
475            echo "#! $(PERL)" > $$i.tmp ; \
476            echo '$$'"bindir='$(bindir)';"                            >> $$i.tmp ; \
477            echo '$$'"libdir='$(libdir)';"                            >> $$i.tmp ; \
478            echo '$$'"libexecdir='$(libexecdir)';"                    >> $$i.tmp ; \
479            echo '$$'"datadir='$(datadir)';"                          >> $$i.tmp ; \
480            cat  $$i                                                >> $$i.tmp ; \
481            echo $(INSTALL_PROGRAM) $(filter-out -s,$(INSTALL_OPTS)) $$i.tmp $(bindir)/$$i ;    \
482            $(INSTALL_PROGRAM) $(filter-out -s,$(INSTALL_BIN_OPTS)) $$i.tmp $(bindir)/$$i ; \
483            $(RM) $$i.tmp; \
484         done
485 else
486         for i in $(INSTALL_SCRIPTS); do \
487                 $(INSTALL_PROGRAM) $(INSTALL_OPTS) $$i $(bindir); \
488         done
489 endif
490 else
491         for i in $(INSTALL_SCRIPTS); do \
492                 $(INSTALL_PROGRAM) $(INSTALL_OPTS) $$i $(bindir); \
493         done
494 endif
495 endif
496
497 ifneq "$(INSTALL_LIB_SCRIPTS)" ""
498 install:: $(INSTALL_LIB_SCRIPTS)
499         @$(INSTALL_DIR) $(libdir)
500 ifeq "$(INTERP)" "perl"
501 ifneq "$(BIN_DIST)" "1"
502         @for i in $(INSTALL_LIB_SCRIPTS); do \
503            $(RM) $$i.tmp; \
504            echo "#! $(PERL)" > $$i.tmp ; \
505            echo '$$'"bindir='$(bindir)';"                            >> $$i.tmp ; \
506            echo '$$'"libdir='$(libdir)';"                            >> $$i.tmp ; \
507            echo '$$'"libexecdir='$(libexecdir)';"                    >> $$i.tmp ; \
508            echo '$$'"datadir='$(datadir)';"                          >> $$i.tmp ; \
509            cat  $$i                                                >> $$i.tmp ; \
510            echo $(INSTALL_PROGRAM) $(INSTALL_OPTS) $$i $(libdir) ;    \
511            $(INSTALL_PROGRAM) $(INSTALL_OPTS) $$i.tmp $(libdir)/$$i ; \
512            $(RM) $$i.tmp; \
513         done
514 else
515         for i in $(INSTALL_LIB_SCRIPTS); do \
516                 $(INSTALL_PROGRAM) $(INSTALL_OPTS) $$i $(libdir); \
517         done
518 endif
519 else
520         for i in $(INSTALL_LIB_SCRIPTS); do \
521                 $(INSTALL_PROGRAM) $(INSTALL_OPTS) $$i $(libdir); \
522         done
523 endif
524 endif
525
526 ifneq "$(INSTALL_LIBEXEC_SCRIPTS)" ""
527 install:: $(INSTALL_LIBEXEC_SCRIPTS)
528         @$(INSTALL_DIR) $(libexecdir)
529 ifeq "$(INTERP)" "perl"
530 ifneq "$(BIN_DIST)" "1"
531         @for i in $(INSTALL_LIBEXEC_SCRIPTS); do \
532            $(RM) $$i.tmp; \
533            echo "#! $(PERL)" > $$i.tmp ; \
534            echo '$$'"bindir='$(bindir)';"                            >> $$i.tmp ; \
535            echo '$$'"libdir='$(libdir)';"                            >> $$i.tmp ; \
536            echo '$$'"libexecdir='$(libexecdir)';"                    >> $$i.tmp ; \
537            echo '$$'"datadir='$(datadir)';"                          >> $$i.tmp ; \
538            cat  $$i                                                >> $$i.tmp ; \
539            echo $(INSTALL_PROGRAM) $(INSTALL_OPTS) $$i $(libexecdir) ;    \
540            $(INSTALL_PROGRAM) $(INSTALL_OPTS) $$i.tmp $(libexecdir)/$$i ; \
541            $(RM) $$i.tmp; \
542         done
543 else
544         for i in $(INSTALL_LIBEXEC_SCRIPTS); do \
545                 $(INSTALL_PROGRAM) $(INSTALL_OPTS) $$i $(libexecdir); \
546         done
547 endif
548 else
549         for i in $(INSTALL_LIBEXEC_SCRIPTS); do \
550                 $(INSTALL_PROGRAM) $(INSTALL_OPTS) $$i $(libexecdir); \
551         done
552 endif
553 endif
554
555 ifneq "$(INSTALL_LIBS)" ""
556 install:: $(INSTALL_LIBS)
557         @$(INSTALL_DIR) $(libdir)
558         for i in $(INSTALL_LIBS); do \
559                 case $$i in \
560                   *.a) \
561                     $(INSTALL_DATA) $(INSTALL_OPTS) $$i $(libdir); \
562                     $(RANLIB) $(libdir)/`basename $$i` ;; \
563                   *) \
564                     $(INSTALL_DATA) $(INSTALL_OPTS) $$i $(libdir); \
565                 esac; \
566         done
567 endif
568
569 ifneq "$(INSTALL_LIBEXECS)" ""
570 install:: $(INSTALL_LIBEXECS)
571         @$(INSTALL_DIR) $(libexecdir)
572         -for i in $(INSTALL_LIBEXECS); do \
573                 $(INSTALL_PROGRAM) $(INSTALL_BIN_OPTS) $$i$(exeext) $(libexecdir); \
574         done
575 endif
576
577 ifneq "$(INSTALL_DATAS)" ""
578 install:: $(INSTALL_DATAS)
579         @$(INSTALL_DIR) $(datadir)
580         for i in $(INSTALL_DATAS); do \
581                 $(INSTALL_DATA) $(INSTALL_OPTS) $$i $(datadir); \
582         done
583 endif
584
585 #
586 # Use with care..
587 #
588 uninstall:: 
589 ifeq ($(INSTALL_PROGS),)
590         @for i in $(INSTALL_PROGS) ; do                         \
591                 echo rm -f $(bindir)/`basename $$i`;            \
592                 rm -f $(bindir)/`basename $$i`;                 \
593         done
594 endif
595 ifeq ($(INSTALL_LIBS),)
596         @for i in $(INSTALL_LIBS); do                           \
597                 echo rm -f $(libdir)/`basename $$i`;            \
598                 rm -f $(libdir)/`basename $$i`;                 \
599         done
600 endif
601 ifeq ($(INSTALL_LIBEXECS),)
602         @for i in $(INSTALL_LIBEXECS); do                       \
603                 echo rm -f $(libexecdir)/`basename $$i`;        \
604                 rm -f $(libexecdir)/`basename $$i`;             \
605         done
606 endif
607 ifeq ($(INSTALL_DATAS),)
608         @for i in $(INSTALL_DATAS); do                          \
609                 echo rm -f $(datadir)/`basename $$i`;           \
610                 rm -f $(datadir)/`basename $$i`;                \
611         done
612 endif
613
614 #
615 # install-strip is from the GNU Makefile standard.
616 #
617 ifneq "$(way)" ""
618 install-strip::
619         @$(MAKE) EXTRA_INSTALL_OPTS='-s' install                                        
620 endif
621
622 ###########################################
623 #
624 #       Targets: dist binary-dist
625 #
626 ###########################################
627
628
629 #
630 # dist-pre is a canned rule the toplevel of your source tree
631 # would use as follows, 
632 #
633 #  dist :: dist-pre
634 #
635 # it performs two tasks, first creating the distribution directory
636 # tree and it then decorates the new tree with symbolic links pointing
637 # to the symbolic links in the build tree.
638 #
639 # The dist-pre relies on (at least) the `find' in GNU findutils
640 # (only tested with version 4.1). All non-GNU `find's I have
641 # laid on my hands locally, has a restrictive treatment of {} in
642 # -exec commands, i.e.,
643 #
644 #   find . -print echo a{} \;
645 #   
646 # does not expand the {}, it has to be a separate argument (i.e. `a {}').
647 # GNU find is (IMHO) more sensible here, expanding any {} it comes across
648 # inside an -exec, whether it is a separate arg or part of a word:
649 #
650 #  $ touch yes
651 #  $ find --version
652 #    GNU find version 4.1
653 #  $ find yes -exec echo oh,{}! \;
654 #    oh,yes!
655 #
656 # Of course, the above is not impossible to achieve with other finds,
657 # just that GNU find does the Patently Right Thing here :)
658 #
659 # ====> if you're using these dist rules, get hold of GNU findutils.
660 #
661 #  --SOF 2/97
662 #
663 .PHONY: dist dist-pre dist-post
664
665 #
666 # The dist rules leaves out CVS, SRC (from mkshadowdir) and tests
667 # directories when creating shadow source distrib tree
668 #
669 dist-pre::
670         -rm -rf $(SRC_DIST_DIR)
671         -rm -f $(SRC_DIST_NAME).tar.gz
672         (cd $(FPTOOLS_TOP_ABS); find $(SRC_DIST_DIRS) -type d \( -name CVS -prune -o -name SRC -prune -o -name tests -prune -o -exec $(MKDIRHIER) $(SRC_DIST_DIR)/{} \; \) ; )
673         (cd $(FPTOOLS_TOP_ABS); find $(SRC_DIST_DIRS) -name CVS -prune -o -name SRC -prune -o -name tests -prune -o -name "*~" -prune -o -name ".cvsignore" -prune -o -name "\#*" -prune -o -name ".\#*" -prune -o -type l -exec $(LN_S) $(FPTOOLS_TOP_ABS)/{} $(SRC_DIST_DIR)/{} \; )
674
675 #
676 # After having created a shadow distribution tree and copied/linked
677 # all the necessary files to it, `dist-post' makes sure the permissions
678 # are set right and then package up the tree. Empty directories are also removed.
679 #
680 # For now, we make the packaging a separate rule, so as to allow
681 # the inspection of the dist tree before eventually packaging it up.
682 #
683 dist-post::
684         @echo Deleting the following empty directories..
685         ( cd $(SRC_DIST_DIR) ; cd .. ; find $(SRC_DIST_NAME) -type d -exec sh -c 'test x`ls $$0 | wc -l | sed -e "s/ //g"` = x0' {} \; -print -exec rm -rf {} \; -prune )
686         ( cd $(SRC_DIST_DIR) ; cd .. ; chmod -R a+rw $(SRC_DIST_NAME) ) 
687
688 dist-package::
689         cd $(SRC_DIST_DIR); cd ..; $(TAR) chzf $(SRC_DIST_NAME).tar.gz $(SRC_DIST_NAME)
690
691 #
692
693
694 # The default dist rule:
695 #
696 # copy/link the contents of $(SRC_DIST_FILES) into the
697 # shadow distribution tree. SRC_DIST_FILES contain the
698 # build-generated files that you want to include in
699 # a source distribution.
700 #
701 #
702 ifneq "$(SRC_DIST_FILES)" ""
703 dist::
704         @for i in $(SRC_DIST_FILES); do                  \
705           if (test -f "$$i"); then                       \
706             echo $(LN_S) `pwd`/$$i $(SRC_DIST_DIR)/$$i ; \
707             $(LN_S) `pwd`/$$i $(SRC_DIST_DIR)/$$i ;      \
708           fi;                                            \
709         done;
710 endif
711
712 #
713 # binary-dist creates a binary bundle, set BIN_DIST_NAME
714 # to package name and do `make binary-dist' (normally this
715 # just a thing you would do from the toplevel of fptools or)
716 # from the top of a project.
717 #
718 .PHONY: binary-dist-pre binary-dist binary-pack
719
720 binary-dist-pre::
721         -rm -rf $(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME)
722         -rm -f $(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME).tar.gz
723         @for i in $(BIN_DIST_DIRS); do                   \
724           if test -d "$$i"; then                         \
725            echo $(MKDIRHIER) $(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME)/bin/$(TARGETPLATFORM)/$(ProjectNameShort)-$(ProjectVersion); \
726            $(MKDIRHIER) $(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME)/bin/$(TARGETPLATFORM)/$(ProjectNameShort)-$(ProjectVersion); \
727            echo $(MKDIRHIER) $(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME)/lib/$(TARGETPLATFORM)/$(ProjectNameShort)-$(ProjectVersion); \
728            $(MKDIRHIER) $(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME)/lib/$(TARGETPLATFORM)/$(ProjectNameShort)-$(ProjectVersion); \
729            echo $(MKDIRHIER) $(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME)/share/$(ProjectNameShort)-$(ProjectVersion); \
730            $(MKDIRHIER) $(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME)/share/$(ProjectNameShort)-$(ProjectVersion); \
731            echo $(MAKE) -C $$i $(MFLAGS) install BIN_DIST=1 BIN_DIST_NAME=$(BIN_DIST_NAME) \
732                         prefix=$(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME) \
733                         exec_prefix=$(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME) \
734                         bindir=$(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME)/bin/$(TARGETPLATFORM)/$(ProjectNameShort)-$(ProjectVersion) \
735                         libdir=$(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME)/lib/$(TARGETPLATFORM)/$(ProjectNameShort)-$(ProjectVersion) \
736                         libexecdir=$(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME)/lib/$(TARGETPLATFORM)/$(ProjectNameShort)-$(ProjectVersion) \
737                         datadir=$(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME)/share/$(ProjectNameShort)-$(ProjectVersion) ; \
738            $(MAKE) -C $$i $(MFLAGS) install BIN_DIST=1 BIN_DIST_NAME=$(BIN_DIST_NAME) \
739                         prefix=$(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME) \
740                         exec_prefix=$(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME) \
741                         bindir=$(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME)/bin/$(TARGETPLATFORM)/$(ProjectNameShort)-$(ProjectVersion) \
742                         libdir=$(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME)/lib/$(TARGETPLATFORM)/$(ProjectNameShort)-$(ProjectVersion) \
743                         libexecdir=$(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME)/lib/$(TARGETPLATFORM)/$(ProjectNameShort)-$(ProjectVersion) \
744                         datadir=$(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME)/share/$(ProjectNameShort)-$(ProjectVersion) ; \
745           fi; \
746         done
747
748 #
749 # Do this separately for now
750
751 binary-pack::
752         ( cd $(BIN_DIST_TMPDIR); $(TAR) chzf $(BIN_DIST_NAME).tar.gz $(BIN_DIST_NAME); rm -rf $(BIN_DIST_NAME) )
753
754 ifneq "$(way)" ""
755 package-way-dist::
756         ( cd $(BIN_DIST_TMPDIR); find $(BIN_DIST_NAME)/ \( -name "*$(_way).a" -o -name "*.$(way_)hi" \) -print | xargs tar cvf $(BIN_DIST_TMPDIR)/ghc-$(ProjectVersion)-$(way)-$(TARGETPLATFORM).tar )
757         gzip $(BIN_DIST_TMPDIR)/ghc-$(ProjectVersion)-$(way)-$(TARGETPLATFORM).tar
758 endif
759
760 ifneq "$(way)" ""
761 remove-way-dist::
762         ( cd $(BIN_DIST_TMPDIR); find $(BIN_DIST_NAME)/ \( -name "*$(_way).a" -o -name "*.$(way_)hi" \) -print -exec rm -f {} \; )
763 endif
764
765 ###########################################
766 #
767 #       Targets: check tags show info
768 #
769 ###########################################
770
771 #------------------------------------------------------------
772 #                       Check
773
774 .PHONY: check
775
776 check:: $(TESTS)
777         @for i in $(filter-out %.lhs .hs, $(TESTS)) ''; do      \
778           if (test -f "$$i"); then              \
779             echo Running: `basename $$i` ;      \
780             cd test; `basename $$i` ;           \
781           fi;                                   \
782         done;
783
784 #------------------------------------------------------------
785 #                       Tags
786
787 .PHONY: TAGS
788
789 TAGS:: $(SOURCES)
790         @$(RM) TAGS
791         @touch TAGS
792 ifneq "$(HS_SRCS)" ""
793         $(HSTAGS) $(HSTAGS_OPTS) -- $(TAGS_HS_SRCS)
794 endif
795 ifneq "$(C_SRCS)" ""
796         etags -a $(TAGS_C_SRCS)
797 endif
798         @( DEREFFED=`ls -l Makefile | sed -e 's/.*-> \(.*\)/\1/g'` && $(RM) `dirname $$DEREFFED`/TAGS && $(CP) TAGS `dirname $$DEREFFED` ) || echo TAGS file generated, perhaps copy over to source tree?
799
800 #------------------------------------------------------------
801 #                       Makefile debugging
802 # to see the effective value used for a Makefile variable, do
803 #  make show VALUE=MY_VALUE
804 #
805
806 show:
807         @echo '$(VALUE)=$($(VALUE))'
808
809 #--------------------------------------------------------------------------
810 # SGML Documentation
811 #
812 .PHONY: dvi ps html info txt
813
814 ifneq "$(SGML_DOC)" ""
815
816 # multi-file SGML document: main document name is specified in $(SGML_DOC),
817 # sub-documents (.sgml files) listed in $(SGML_SRCS).
818
819 $(SGML_DOC).sgml : $(SGML_SRCS)
820         cat $(SGML_SRCS) > $(SGML_DOC).sgml
821
822 SGML_DVI  = $(SGML_DOC).dvi
823 SGML_PS   = $(SGML_DOC).ps
824 SGML_INFO = $(SGML_DOC).info
825 SGML_HTML = $(SGML_DOC).html
826 SGML_TEXT = $(SGML_DOC).txt
827
828 else # no SGML_DOC
829
830 VSGML_SRCS = $(wildcard *.vsgml)
831
832 ifneq "$(VSGML_SRCS)" ""
833 SGML_SRCS  = $(addsuffix .sgml, $(basename $(VSGML_SRCS)))
834 else
835 SGML_SRCS  = $(wildcard *.sgml)
836 endif
837
838 SGML_DVI  = $(addsuffix  .dvi, $(basename $(SGML_SRCS)))
839 SGML_PS   = $(addsuffix   .ps, $(basename $(SGML_SRCS)))
840 SGML_INFO = $(addsuffix .info, $(basename $(SGML_SRCS)))
841 SGML_HTML = $(addsuffix .html, $(basename $(SGML_SRCS)))
842 SGML_TEXT = $(addsuffix  .txt, $(basename $(SGML_SRCS)))
843
844 endif # SGML_DOC
845
846 dvi  :: $(SGML_DVI)
847 info :: $(SGML_INFO)
848 html :: $(SGML_HTML)
849 txt  :: $(SGML_TXT)
850 ps   :: $(SGML_PS)
851
852 CLEAN_FILES += $(SGML_TEXT) $(SGML_HTML) $(SGML_PS) $(SGML_DVI)
853
854 ###########################################
855 #
856 #       Targets: clean
857 #
858 ###########################################
859
860 .PHONY: realclean mostlyclean clean distclean maintainer-clean
861
862 # realclean is just a synonym for maintainer-clean
863 realclean: maintainer-clean
864
865
866 ifneq "$(MOSTLY_CLEAN_FILES)" ""
867 mostlyclean::
868         rm -f $(MOSTLY_CLEAN_FILES)
869 endif
870
871 ifneq "$(CLEAN_FILES)" ""
872 clean:: mostlyclean
873         rm -f $(CLEAN_FILES)
874 endif
875
876
877 ifneq "$(DIST_CLEAN_FILES)" ""
878 distclean:: mostlyclean clean
879         rm -f $(DIST_CLEAN_FILES)
880 endif
881
882
883 ifneq "$(MAINTAINER_CLEAN_FILES)" ""
884 maintainer-clean:: mostlyclean clean distclean
885         @echo 'This command is intended for maintainers to use; it'
886         @echo 'deletes files that may need special tools to rebuild.'
887         rm -f $(MAINTAINER_CLEAN_FILES)
888 endif
889
890 #
891 # If (Haskell) object files are split, cleaning up 
892 # consist of descending into the directories where
893 # the myriads of object files have been put.
894 #
895
896 ifneq "$(HS_OBJS)" ""
897 ifneq "$(filter -split-objs,$(HC_OPTS))" ""
898 clean ::
899         find $(patsubst %.$(way_)o,%,$(HS_OBJS)) -name '*.$(way_)o' -print | xargs $(RM) __rm_food
900         -rmdir $(patsubst %.$(way_)o,%,$(HS_OBJS))
901 endif
902 endif
903
904
905 #################################################################################
906 #
907 #                       Way management
908 #
909 #################################################################################
910
911 # Here is the ingenious jiggery pokery that allows you to build multiple versions
912 # of a program in a single build tree.
913 #
914 # The ways setup requires the following variables to be set:
915 #
916 # Expects:      $(WAYS)                 the possible "way" strings to one of 
917 #                                       which $(way) will be set
918
919
920 # So how does $(way) ever get set to anything?  Answer, we recursively
921 # invoke make, setting $(way) on the command line.
922 # When do we do this recursion?  Answer: whenever the programmer
923 # asks make to make a target that involves a way suffix.
924 # We must remember *not* to recurse again; but that's easy: we
925 # just see if $(way) is set:
926
927 ifeq "$(way)" ""
928
929 # If $(WAYS) = p mc, then WAY_TARGETS expands to
930 #       %.p_lhs %.p_hs %.p_o ... %.mc_lhs %.p_hs ...
931 # and OTHER_WAY_TARGETS to
932 #       %_p.a %_p %_mc.a %_mc
933 # where the suffixes are from $(SUFFIXES)
934 #
935 # We have to treat libraries and "other" targets differently, 
936 # because their names are of the form
937 #       libHS_p.a and Foo_p
938 # whereas everything else has names of the form
939 #       Foo.p_o
940
941 FPTOOLS_SUFFIXES := o hi hc
942
943 WAY_TARGETS     = $(foreach way,$(WAYS),$(foreach suffix, $(FPTOOLS_SUFFIXES), %.$(way)_$(suffix)))
944 LIB_WAY_TARGETS = $(foreach way,$(WAYS),%_$(way).a %_$(way))
945
946 # $@ will be something like Foo.p_o
947 # $(suffix $@)     returns .p_o
948 # $(subst .,.p_o)  returns p_o
949 # $(subst _,.,p_o) returns p.o   (clever)
950 # $(basename p.o)  returns p
951
952 $(WAY_TARGETS) :
953         $(MAKE) way=$(basename $(subst _,.,$(subst .,,$(suffix $@)))) $@
954
955 # $(@F) will be something like libHS_p.a, or Foo_p
956 # $(basename $(@F)) will be libHS_p, or Foo_p
957 # The sed script extracts the "p" part.
958
959 $(LIB_WAY_TARGETS) :
960         $(MAKE) $(MFLAGS) $@ way=$(subst .,,$(suffix $(subst _,.,$(basename $@))))
961
962 endif   # if way
963
964
965 ##################################################################
966 #
967 #               Recursive stuff
968 #
969 ##################################################################
970
971 # Here are the diabolically clever rules that
972
973 # (a) for each "recursive target" <t>
974 #     propagates "make <t>" to directories in SUBDIRS
975 #
976 # (b) when SUBDIRS is empty,
977 #     for each "multi-way-target" <t>
978 #     calls "make -way=w <t>" for each w in $(WAYS)
979 #
980 #     This has the effect of making the standard target
981 #     in each of the specified ways (as well as in the normal way
982
983 # Controlling variables
984 #       WAYS    = extra (beyond the normal way) ways to build things in
985 #       SUBDIRS = subdirectories to recurse into
986
987 # No ways, so iterate over the SUBDIRS
988
989 # note about recursively invoking make: we'd like make to drop all the
990 # way back to the top level if it fails in any of the
991 # sub(sub-...)directories.  This is done by setting the -e flag to the
992 # shell during the loop, which causes an immediate failure if any of
993 # the shell commands fail.
994
995 # One exception: if the user gave the -i or -k flag to make in the
996 # first place, we'd like to reverse this behaviour.  So we check for
997 # these flags, and set the -e flag appropriately.  NOTE: watch out for
998 # the --no-print-directory flag which is passed to recursive
999 # invocations of make.
1000
1001 ifeq "$(way)" ""
1002 ifneq "$(SUBDIRS)" ""
1003
1004 all docs runtests boot TAGS clean veryclean maintainer-clean install info ::
1005         @echo "------------------------------------------------------------------------"
1006         @echo "===fptools== Recursively making \`$@' in $(SUBDIRS) ..."
1007         @echo "PWD = $(shell pwd)"
1008         @echo "------------------------------------------------------------------------"
1009         @case '${MFLAGS}' in *-[ik]*) set +e;; *-r*[ik]*) set +e;; *) set -e;; esac; \
1010         for i in $(SUBDIRS) ; do \
1011           echo "------------------------------------------------------------------------"; \
1012           echo "==fptools== $(MAKE) $@ $(MFLAGS);"; \
1013           echo " in $(shell pwd)/$$i"; \
1014           echo "------------------------------------------------------------------------"; \
1015           $(MAKE) --no-print-directory -C $$i $(MFLAGS) $@; \
1016         done
1017         @echo "------------------------------------------------------------------------"
1018         @echo "===fptools== Finished making \`$@' in $(SUBDIRS) ..."
1019         @echo "PWD = $(shell pwd)"
1020         @echo "------------------------------------------------------------------------"
1021
1022 dist ::
1023         @case '${MFLAGS}' in *-[ik]*) set +e;; *-r*[ik]*) set +e;; *) set -e;; esac; \
1024         for i in $(SUBDIRS) ; do \
1025           $(MKDIRHIER_PREFIX)mkdirhier $(SRC_DIST_DIR)/$$i; \
1026           $(MAKE) -C $$i $(MFLAGS) $@ SRC_DIST_DIR=$(SRC_DIST_DIR)/$$i; \
1027         done
1028 endif
1029 endif
1030
1031 #
1032 # Selectively building subdirectories.
1033 #
1034 #
1035 ifneq "$(SUBDIRS)" ""
1036 $(SUBDIRS) ::
1037           $(MAKE) -C $@ $(MFLAGS)
1038 endif
1039
1040 ifneq "$(WAYS)" ""
1041 ifeq "$(way)" ""
1042
1043 # NB: the targets exclude 
1044 #       boot info TAGS
1045 # since these are way-independent
1046 all docs runtests TAGS clean veryclean maintainer-clean install ::
1047         @echo "------------------------------------------------------------------------"
1048         @echo "===fptools== Recursively making \`$@' for ways: $(WAYS) ..."
1049         @echo "PWD = $(shell pwd)"
1050         @echo "------------------------------------------------------------------------"
1051         @case '${MFLAGS}' in *-[ik]*) set +e;; *-r*[ik]*) set +e;; *) set -e;; esac; \
1052         for i in $(WAYS) ; do \
1053           echo "------------------------------------------------------------------------"; \
1054           echo "==fptools== $(MAKE) way=$$i $@;"; \
1055           echo "PWD = $(shell pwd)"; \
1056           echo "------------------------------------------------------------------------"; \
1057           $(MAKE) way=$$i --no-print-directory $(MFLAGS) $@ ; \
1058         done
1059         @echo "------------------------------------------------------------------------"
1060         @echo "===fptools== Finished recursively making \`$@' for ways: $(WAYS) ..."
1061         @echo "PWD = $(shell pwd)"
1062         @echo "------------------------------------------------------------------------"
1063
1064 endif
1065 endif
1066