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