1 <!DOCTYPE Article PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
3 <Article id="building-guide">
7 <Title>Building the Glasgow Functional Programming Tools Suite</Title>
8 <Author><OtherName>The GHC Team</OtherName></Author>
9 <Address><Email>glasgow-haskell-{users,bugs}@haskell.org</Email></Address>
10 <PubDate>January 2000</PubDate>
15 This guide is intended for people who want to build or modify
16 programs from the Glasgow <Literal>fptools</Literal> suite (as distinct from those
17 who merely want to <Emphasis>run</Emphasis> them). Installation instructions are now provided in the user guide.
21 The bulk of this guide applies to building on Unix systems; see <XRef LinkEnd="winbuild"> for Windows notes.
29 <Sect1 id="sec-getting">
30 <Title>Getting the Glasgow <Literal>fptools</Literal> suite
34 Building the Glasgow tools <Emphasis>can</Emphasis> be complicated, mostly because
35 there are so many permutations of what/why/how, e.g., ``Build Happy
36 with HBC, everything else with GHC, leave out profiling, and test it
37 all on the `real' NoFib programs.'' Yeeps!
41 Happily, such complications don't apply to most people. A few common
42 ``strategies'' serve most purposes. Pick one and proceed
50 <Term><IndexTerm><Primary>Binary distribution</Primary></IndexTerm>Binary distribution.</Term>
53 If your only purpose is to install some of the <Literal>fptools</Literal> suite then the easiest thing to do is to get a binary distribution. In the
54 binary distribution everything is pre-compiled for your particular
55 machine architecture and operating system, so all you should have to
56 do is install the binaries and libraries in suitable places. The user guide
57 describes how to do this.
61 A binary distribution may not work for you for two reasons. First, we
62 may not have built the suite for the particular architecture/OS
63 platform you want. That may be due to lack of time and energy (in
64 which case you can get a source distribution and build from it; see
65 below). Alternatively, it may be because we haven't yet ported the
66 suite to your architecture, in which case you are considerably worse
71 The second reason a binary distribution may not be what you want is
72 if you want to read or modify the souce code.
74 </ListItem></VarListEntry>
76 <Term><IndexTerm><Primary>Source distribution</Primary></IndexTerm>Source distribution.</Term>
80 platform, but (a) you like the warm fuzzy feeling of compiling things
81 yourself; (b) you want to build something ``extra''—e.g., a set of
82 libraries with strictness-analysis turned off; or (c) you want to hack
87 A source distribution contains complete sources for one or more
88 projects in the <Literal>fptools</Literal> suite. Not only that, but the more awkward
89 machine-independent steps are done for you. For example, if you don't
90 have <Command>flex</Command><IndexTerm><Primary>flex</Primary></IndexTerm> you'll find it convenient that the source
91 distribution contains the result of running <Command>flex</Command> on the lexical
92 analyser specification. If you don't want to alter the lexical
93 analyser then this saves you having to find and install <Command>flex</Command>. You
94 will still need a working version of GHC on your machine in order to
95 compile (most of) the sources, however.
99 We make source distributions more frequently than binary
100 distributions; a release that comes with pre-compiled binaries
101 is considered a major release, i.e., a release that we have some
102 confidence will work well by having tested it (more) thoroughly.
106 Source-only distributions are either bugfix releases or snapshots of
107 current state of development. The release has undergone some testing.
108 Source releases of GHC 4.xx can be compiled up using GHC 2.10 or
111 </ListItem></VarListEntry>
113 <Term>Build GHC from intermediate C <Filename>.hc</Filename> files<IndexTerm><Primary>hc files</Primary></IndexTerm>:</Term>
117 need a working GHC to use a source distribution. What if you don't
118 have a working GHC? Then you have no choice but to ``bootstrap'' up
119 from the intermediate C (<Filename>.hc</Filename>) files that we provide. Building GHC
120 on an unsupported platform falls into this category. Please see
121 <Xref LinkEnd="sec-booting-from-C">.
125 Once you have built GHC, you can build the other Glasgow tools with
130 In theory, you can (could?) build GHC with another Haskell compiler
131 (e.g., HBC). We haven't tried to do this for ages and it almost
132 certainly doesn't work any more (for tedious reasons).
134 </ListItem></VarListEntry>
136 <Term>The CVS repository.</Term>
139 We make source distributions slightly more often than binary
140 distributions; but still infrequently. If you want more up-to-the
141 minute (but less tested) source code then you need to get access to
146 All the <Literal>fptools</Literal> source code is held in a CVS repository. CVS is a
147 pretty good source-code control system, and best of all it works over
152 The repository holds source code only. It holds no mechanically
153 generated files at all. So if you check out a source tree from CVS
154 you will need to install every utility so that you can build all the
155 derived files from scratch.
159 More information about our CVS repository is available in the <ULink
160 URL="http://www.haskell.org/ghc/cvs-cheat-sheet.html" >FPTools CVS
161 Cheat Sheet</ULink >.
163 </ListItem></VarListEntry>
168 If you are going to do any building from sources (either from a source
169 distribution or the CVS repository) then you need to read all of this
176 <Title>Things to check before you start typing</Title>
179 Here's a list of things to check before you get started.
185 <IndexTerm><Primary>Disk space needed</Primary></IndexTerm>
186 Disk space needed: About 40MB (one tenth of one hamburger's worth) of disk
187 space for the most basic binary distribution of GHC; more for some
188 platforms, e.g., Alphas. An extra ``bundle'' (e.g., concurrent Haskell
189 libraries) might take you to up to one fifth of a hamburger. You'll need
190 over 100MB (say, one fifth a hamburger's worth) if you need to build the
191 basic stuff from scratch. All of the above are
192 <Emphasis>estimates</Emphasis> of disk-space needs. (Note: our benchmark hamburger is a standard Double Whopper with Cheese, with an RRP of UKP2.99.)
198 Use an appropriate machine, compilers, and things.
199 SPARC boxes, and PCs running Linux, FreeBSD, NetBSD, or Solaris are
200 all fully supported. Win32 and HP boxes are in pretty good shape.
201 DEC Alphas running OSF/1, Linux or some BSD variant, MIPS and AIX
202 boxes will need some minimal porting effort before they work (as of
203 4.06). <Xref LinkEnd="sec-port-info"> gives the full run-down on
204 ports or lack thereof.
210 Be sure that the ``pre-supposed'' utilities are installed.
211 <Xref LinkEnd="sec-pre-supposed"> elaborates.
218 If you have any problem when building or installing the Glasgow
219 tools, please check the ``known pitfalls'' (<Xref
220 LinkEnd="sec-build-pitfalls">). Also check the FAQ for the version
221 you're building, which should be available from the relevant download
222 page on the <ULink URL="http://www.haskell.org/ghc/" >GHC web
225 <IndexTerm><Primary>known bugs</Primary></IndexTerm>
226 <IndexTerm><Primary>bugs, known</Primary></IndexTerm>
228 If you feel there is still some shortcoming in our procedure or
229 instructions, please report it.
231 For GHC, please see the bug-reporting section of the GHC Users' Guide
232 (separate document), to maximise the usefulness of your report.
233 <IndexTerm><Primary>bugs, reporting</Primary></IndexTerm>
235 If in doubt, please send a message to
236 <Email>glasgow-haskell-bugs@haskell.org</Email>.
237 <IndexTerm><Primary>bugs, mailing list</Primary></IndexTerm>
247 <Sect1 id="sec-port-info">
248 <Title>What machines the Glasgow tools run on
252 <IndexTerm><Primary>ports, GHC</Primary></IndexTerm>
253 <IndexTerm><Primary>GHC ports</Primary></IndexTerm>
254 <IndexTerm><Primary>supported platforms</Primary></IndexTerm>
255 <IndexTerm><Primary>platforms, supported</Primary></IndexTerm>
256 The main question is whether or not the Haskell compiler (GHC) runs on
261 A ``platform'' is a architecture/manufacturer/operating-system
262 combination, such as <Literal>sparc-sun-solaris2</Literal>. Other common ones are
263 <Literal>alpha-dec-osf2</Literal>, <Literal>hppa1.1-hp-hpux9</Literal>, <Literal>i386-unknown-linux</Literal>,
264 <Literal>i386-unknown-solaris2</Literal>, <Literal>i386-unknown-freebsd</Literal>,
265 <Literal>i386-unknown-cygwin32</Literal>, <Literal>m68k-sun-sunos4</Literal>, <Literal>mips-sgi-irix5</Literal>,
266 <Literal>sparc-sun-sunos4</Literal>, <Literal>sparc-sun-solaris2</Literal>, <Literal>powerpc-ibm-aix</Literal>.
270 Bear in mind that certain ``bundles'', e.g. parallel Haskell, may not
271 work on all machines for which basic Haskell compiling is supported.
275 Some libraries may only work on a limited number of platforms; for
276 example, a sockets library is of no use unless the operating system
277 supports the underlying BSDisms.
281 <Title>What platforms the Haskell compiler (GHC) runs on</Title>
284 <IndexTerm><Primary>fully-supported platforms</Primary></IndexTerm>
285 <IndexTerm><Primary>native-code generator</Primary></IndexTerm>
286 <IndexTerm><Primary>registerised ports</Primary></IndexTerm>
287 <IndexTerm><Primary>unregisterised ports</Primary></IndexTerm>
288 The GHC hierarchy of Porting Goodness: (a) Best is a native-code
289 generator; (b) next best is a ``registerised''
290 port; (c) the bare minimum is an ``unregisterised'' port.
291 (``Unregisterised'' is so terrible that we won't say more about it).
295 The native code generator is currently non-functional (as of GHC
296 version 4.06), but we're actively working on getting it going again.
300 We use Sparcs running Solaris 2.7 and x86 boxes running FreeBSD and
301 Linux, so those are the best supported platforms, unsurprisingly.
305 Here's everything that's known about GHC ports. We identify platforms
306 by their ``canonical'' CPU/Manufacturer/OS triple.
313 <Term>alpha-dec-{osf,linux,freebsd,openbsd,netbsd}:</Term>
314 <IndexTerm><Primary>alpha-dec-osf</Primary></IndexTerm>
315 <IndexTerm><Primary>alpha-dec-linux</Primary></IndexTerm>
316 <IndexTerm><Primary>alpha-dec-freebsd</Primary></IndexTerm>
317 <IndexTerm><Primary>alpha-dec-openbsd</Primary></IndexTerm>
318 <IndexTerm><Primary>alpha-dec-netbsd</Primary></IndexTerm>
322 Currently non-working. The last working version (osf[1-3]) is GHC
323 3.02. A small amount of porting effort will be required to get Alpha
324 support into GHC 4.xx, but we don't have easy access to machines right
325 now, and there hasn't been a massive demand for support, so Alphas
326 remain unsupported for the time being. Please get in touch if you
327 either need Alpha support and/or can provide access to boxes.
330 </ListItem></VarListEntry>
332 <Term>sparc-sun-sunos4:</Term>
333 <IndexTerm><Primary>sparc-sun-sunos4</Primary></IndexTerm>
337 Probably works with minor tweaks, hasn't been tested for a while.
340 </ListItem></VarListEntry>
342 <Term>sparc-sun-solaris2:</Term>
343 <IndexTerm><Primary>sparc-sun-solaris2</Primary></IndexTerm>
347 Fully supported, including native-code generator.
350 </ListItem></VarListEntry>
352 <Term>hppa1.1-hp-hpux (HP-PA boxes running HPUX 9.x)</Term>
353 <IndexTerm><Primary>hppa1.1-hp-hpux</Primary></IndexTerm>
357 Works registerised. No native-code generator.
360 </ListItem></VarListEntry>
362 <Term>i386-unknown-linux (PCs running Linux—ELF binary format):</Term>
363 <IndexTerm><Primary>i386-*-linux</Primary></IndexTerm>
367 GHC works registerised. You <Emphasis>must</Emphasis> have GCC 2.7.x
368 or later. NOTE about <literal>glibc</literal> versions: GHC binaries
369 built on a system running <literal>glibc 2.0</literal> won't work on a
370 system running <literal>glibc 2.1</literal>, and vice version. In
371 general, don't expect compatibility between <literal>glibc</literal>
372 versions, even if the shared library version hasn't changed.
375 </ListItem></VarListEntry>
377 <Term>i386-unknown-{freebsd,netbsd,openbsd) (PCs running FreeBSD 2.2
378 or higher, NetBSD, and possibly OpenBSD):</Term>
379 <IndexTerm><Primary>i386-unknown-freebsd</Primary></IndexTerm>
380 <IndexTerm><Primary>i386-unknown-netbsd</Primary></IndexTerm>
381 <IndexTerm><Primary>i386-unknown-openbsd</Primary></IndexTerm>
385 GHC works registerised. These systems provide ready-built packages of
386 GHC, so if you just need binaries you're better off just installing
390 </ListItem></VarListEntry>
392 <Term>i386-unknown-cygwin32:</Term>
393 <IndexTerm><Primary>i386-unknown-cygwin32</Primary></IndexTerm>
397 Fully supported under Win9x/NT, including a native code
398 generator. Requires the <Literal>cygwin32</Literal> compatibility
399 library and a healthy collection of GNU tools (i.e., gcc, GNU ld, bash
403 </ListItem></VarListEntry>
405 <Term>mips-sgi-irix5:</Term>
406 <IndexTerm><Primary>mips-sgi-irix[5-6]</Primary></IndexTerm>
410 Port currently doesn't work, needs some minimal porting effort. As
411 usual, we don't have access to machines and there hasn't been an
412 overwhelming demand for this port, but feel free to get in touch.
414 </ListItem></VarListEntry>
417 <Term>powerpc-ibm-aix:</Term>
420 <IndexTerm><Primary>powerpc-ibm-aix</Primary></IndexTerm>
421 Port currently doesn't work, needs some minimal porting effort. As
422 usual, we don't have access to machines and there hasn't been an
423 overwhelming demand for this port, but feel free to get in touch.
425 </ListItem></VarListEntry>
431 Various other systems have had GHC ported to them in the distant past,
432 including various Motorola 68k boxes. The 68k support still remains,
433 but porting to one of these systems will certainly be a non-trivial
440 <Title>What machines the other tools run on</Title>
443 Unless you hear otherwise, the other tools work if GHC works.
451 <Sect1 id="sec-pre-supposed">
452 <Title>Installing pre-supposed utilities
454 <IndexTerm><Primary>pre-supposed utilities</Primary></IndexTerm>
455 <IndexTerm><Primary>utilities, pre-supposed</Primary></IndexTerm></Title>
458 Here are the gory details about some utility programs you may need;
459 <Command>perl</Command>, <Command>gcc</Command> and
460 <command>happy</command> are the only important
461 ones. (PVM<IndexTerm><Primary>PVM</Primary></IndexTerm> is important
462 if you're going for Parallel Haskell.) The
463 <Command>configure</Command><IndexTerm><Primary>configure</Primary></IndexTerm>
464 script will tell you if you are missing something.
472 <IndexTerm><Primary>pre-supposed: Perl</Primary></IndexTerm>
473 <IndexTerm><Primary>Perl, pre-supposed</Primary></IndexTerm>
476 <Emphasis>You have to have Perl to proceed!</Emphasis> Perl is a
477 language quite good for doing shell-scripty tasks that involve lots of
478 text processing. It is pretty easy to install.
482 Perl 5 is required. For Win32 platforms, we strongly suggest you
483 pick up a port of Perl 5 for <Literal>cygwin32</Literal>, as the
484 common Hip/ActiveWare port of Perl is Not Cool Enough for our
489 Perl should be put somewhere so that it can be invoked by the
490 <Literal>#!</Literal> script-invoking mechanism. (I believe
491 <Filename>/usr/bin/perl</Filename> is preferred; we use
492 <Filename>/usr/local/bin/perl</Filename> at Glasgow.) The full
493 pathname should may need to be less than 32 characters long on some
497 </ListItem></VarListEntry>
499 <Term>GNU C (<Command>gcc</Command>):</Term>
500 <IndexTerm><Primary>pre-supposed: GCC (GNU C compiler)</Primary></IndexTerm>
501 <IndexTerm><Primary>GCC (GNU C compiler), pre-supposed</Primary></IndexTerm>
505 We recommend using GCC version 2.95.2 on all platforms. Failing that,
506 version 2.7.2 is stable on most platforms. Earlier versions of GCC
507 can be assumed not to work, and versions in between 2.7.2 and 2.95.2
508 (including <command>egcs</command>) have varying degrees of stability
509 depending on the platform.
513 If your GCC dies with ``internal error'' on some GHC source file,
514 please let us know, so we can report it and get things improved.
515 (Exception: on iX86 boxes—you may need to fiddle with GHC's
516 <Option>-monly-N-regs</Option> option; see the User's Guide)
518 </ListItem></VarListEntry>
522 <indexterm><primary>Happy</primary></indexterm>
524 <para>Happy is a parser generator tool for Haskell, and is used to
525 generate GHC's parsers. Happy is written in Haskell, and is a project
526 in the CVS repository (<literal>fptools/happy</literal>). It can be
527 built from source, but bear in mind that you'll need GHC installed in
528 order to build it. To avoid the chicken/egg problem, install a binary
529 distribtion of either Happy or GHC to get started. Happy
530 distributions are available from <ulink
531 url="http://www.haskell.org/happy/">Happy's Web Page</ulink>.
537 <Term>Autoconf:</Term>
538 <IndexTerm><Primary>pre-supposed: Autoconf</Primary></IndexTerm>
539 <IndexTerm><Primary>Autoconf, pre-supposed</Primary></IndexTerm>
542 GNU Autoconf is needed if you intend to build from the CVS sources, it
543 is <Emphasis>not</Emphasis> needed if you just intend to build a
544 standard source distribution.
548 Autoconf builds the <Command>configure</Command> script from
549 <Filename>configure.in</Filename> and <Filename>aclocal.m4</Filename>.
550 If you modify either of these files, you'll need Autoconf to rebuild
551 <Filename>configure</Filename>.
554 </ListItem></VarListEntry>
556 <Term><Command>sed</Command></Term>
557 <IndexTerm><Primary>pre-supposed: sed</Primary></IndexTerm>
558 <IndexTerm><Primary>sed, pre-supposed</Primary></IndexTerm>
561 You need a working <Command>sed</Command> if you are going to build
562 from sources. The build-configuration stuff needs it. GNU sed
563 version 2.0.4 is no good! It has a bug in it that is tickled by the
564 build-configuration. 2.0.5 is OK. Others are probably OK too
565 (assuming we don't create too elaborate configure scripts.)
567 </ListItem></VarListEntry>
572 One <Literal>fptools</Literal> project is worth a quick note at this
573 point, because it is useful for all the others:
574 <Literal>glafp-utils</Literal> contains several utilities which aren't
575 particularly Glasgow-ish, but Occasionally Indispensable. Like
576 <Command>lndir</Command> for creating symbolic link trees.
579 <Sect2 id="pre-supposed-gph-tools">
580 <Title>Tools for building parallel GHC (GPH)
587 <Term>PVM version 3:</Term>
588 <IndexTerm><Primary>pre-supposed: PVM3 (Parallel Virtual Machine)</Primary></IndexTerm>
589 <IndexTerm><Primary>PVM3 (Parallel Virtual Machine), pre-supposed</Primary></IndexTerm>
593 PVM is the Parallel Virtual Machine on which Parallel Haskell programs
594 run. (You only need this if you plan to run Parallel Haskell.
595 Concurent Haskell, which runs concurrent threads on a uniprocessor
596 doesn't need it.) Underneath PVM, you can have (for example) a
597 network of workstations (slow) or a multiprocessor box (faster).
601 The current version of PVM is 3.3.11; we use 3.3.7. It is readily
602 available on the net; I think I got it from
603 <Literal>research.att.com</Literal>, in <Filename>netlib</Filename>.
607 A PVM installation is slightly quirky, but easy to do. Just follow
608 the <Filename>Readme</Filename> instructions.
610 </ListItem></VarListEntry>
612 <Term><Command>bash</Command>:</Term>
613 <IndexTerm><Primary>bash, presupposed (Parallel Haskell only)</Primary></IndexTerm>
616 Sadly, the <Command>gr2ps</Command> script, used to convert ``parallelism profiles''
617 to PostScript, is written in Bash (GNU's Bourne Again shell).
618 This bug will be fixed (someday).
620 </ListItem></VarListEntry>
626 <Sect2 id="pre-supposed-doc-tools">
627 <Title>Tools for building the Documentation
631 The following additional tools are required if you want to format the
632 documentation that comes with the <Literal>fptools</Literal> projects:
639 <Term>DocBook:</Term>
640 <IndexTerm><Primary>pre-supposed: DocBook</Primary></IndexTerm>
641 <IndexTerm><Primary>DocBook, pre-supposed</Primary></IndexTerm>
644 All our documentation is written in SGML, using the DocBook DTD. Instructions on installing and configuring the DocBook tools are in the installation guide (<XRef LinkEnd="building-docs">).
647 </ListItem></VarListEntry>
650 <IndexTerm><Primary>pre-supposed: TeX</Primary></IndexTerm>
651 <IndexTerm><Primary>TeX, pre-supposed</Primary></IndexTerm>
654 A decent TeX distribution is required if you want to produce printable
655 documentation. We recomment teTeX, which includes just about
658 </ListItem></VarListEntry>
664 <Sect2 id="pre-supposed-other-tools">
665 <Title>Other useful tools
671 <IndexTerm><Primary>pre-supposed: flex</Primary></IndexTerm>
672 <IndexTerm><Primary>flex, pre-supposed</Primary></IndexTerm>
676 This is a quite-a-bit-better-than-Lex lexer. Used to build a couple
677 of utilities in <Literal>glafp-utils</Literal>. Depending on your
678 operating system, the supplied <Command>lex</Command> may or may not
679 work; you should get the GNU version.
681 </ListItem></VarListEntry>
688 <Sect1 id="sec-building-from-source">
689 <Title>Building from source
691 <IndexTerm><Primary>Building from source</Primary></IndexTerm>
692 <IndexTerm><Primary>Source, building from</Primary></IndexTerm></Title>
695 You've been rash enough to want to build some of
696 the Glasgow Functional Programming tools (GHC, Happy,
697 nofib, etc.) from source. You've slurped the source,
698 from the CVS repository or from a source distribution, and
699 now you're sitting looking at a huge mound of bits, wondering
704 Gingerly, you type <Command>make</Command>. Wrong already!
708 This rest of this guide is intended for duffers like me, who aren't
709 really interested in Makefiles and systems configurations, but who
710 need a mental model of the interlocking pieces so that they can make
711 them work, extend them consistently when adding new software, and lay
712 hands on them gently when they don't work.
715 <Sect2 id="sec-source-tree">
716 <Title>Your source tree
720 The source code is held in your <Emphasis>source tree</Emphasis>.
721 The root directory of your source tree <Emphasis>must</Emphasis>
722 contain the following directories and files:
731 <Filename>Makefile</Filename>: the root Makefile.
737 <Filename>mk/</Filename>: the directory that contains the
738 main Makefile code, shared by all the
739 <Literal>fptools</Literal> software.
745 <Filename>configure.in</Filename>, <Filename>config.sub</Filename>, <Filename>config.guess</Filename>:
746 these files support the configuration process.
752 <Filename>install-sh</Filename>.
761 All the other directories are individual <Emphasis>projects</Emphasis> of the
762 <Literal>fptools</Literal> system—for example, the Glasgow Haskell Compiler
763 (<Literal>ghc</Literal>), the Happy parser generator (<Literal>happy</Literal>), the <Literal>nofib</Literal> benchmark
764 suite, and so on. You can have zero or more of these. Needless to
765 say, some of them are needed to build others.
769 The important thing to remember is that even if you want only one
770 project (<Literal>happy</Literal>, say), you must have a source tree whose root
771 directory contains <Filename>Makefile</Filename>, <Filename>mk/</Filename>, <Filename>configure.in</Filename>, and the
772 project(s) you want (<Filename>happy/</Filename> in this case). You cannot get by with
773 just the <Filename>happy/</Filename> directory.
780 <IndexTerm><Primary>build trees</Primary></IndexTerm>
781 <IndexTerm><Primary>link trees, for building</Primary></IndexTerm></Title>
784 While you can build a system in the source tree, we don't recommend it.
785 We often want to build multiple versions of our software
786 for different architectures, or with different options (e.g. profiling).
787 It's very desirable to share a single copy of the source code among
792 So for every source tree we have zero or more <Emphasis>build trees</Emphasis>. Each
793 build tree is initially an exact copy of the source tree, except that
794 each file is a symbolic link to the source file, rather than being a
795 copy of the source file. There are ``standard'' Unix utilities that
796 make such copies, so standard that they go by different names:
797 <Command>lndir</Command><IndexTerm><Primary>lndir</Primary></IndexTerm>, <Command>mkshadowdir</Command><IndexTerm><Primary>mkshadowdir</Primary></IndexTerm> are two (If you
798 don't have either, the source distribution includes sources for the
799 X11 <Command>lndir</Command>—check out <Filename>fptools/glafp-utils/lndir</Filename>). See <Xref LinkEnd="sec-storysofar"> for a typical invocation.
803 The build tree does not need to be anywhere near the source tree in
804 the file system. Indeed, one advantage of separating the build tree
805 from the source is that the build tree can be placed in a
806 non-backed-up partition, saving your systems support people from
807 backing up untold megabytes of easily-regenerated, and
808 rapidly-changing, gubbins. The golden rule is that (with a single
809 exception—<XRef LinkEnd="sec-build-config">)
810 <Emphasis>absolutely everything in the build tree is either a symbolic
811 link to the source tree, or else is mechanically generated</Emphasis>.
812 It should be perfectly OK for your build tree to vanish overnight; an
813 hour or two compiling and you're on the road again.
817 You need to be a bit careful, though, that any new files you create
818 (if you do any development work) are in the source tree, not a build tree!
822 Remember, that the source files in the build tree are <Emphasis>symbolic
823 links</Emphasis> to the files in the source tree. (The build tree soon
824 accumulates lots of built files like <Filename>Foo.o</Filename>, as well.) You
825 can <Emphasis>delete</Emphasis> a source file from the build tree without affecting
826 the source tree (though it's an odd thing to do). On the other hand,
827 if you <Emphasis>edit</Emphasis> a source file from the build tree, you'll edit the
828 source-tree file directly. (You can set up Emacs so that if you edit
829 a source file from the build tree, Emacs will silently create an
830 edited copy of the source file in the build tree, leaving the source
831 file unchanged; but the danger is that you think you've edited the
832 source file whereas actually all you've done is edit the build-tree
833 copy. More commonly you do want to edit the source file.)
837 Like the source tree, the top level of your build tree must be (a
838 linked copy of) the root directory of the <Literal>fptools</Literal> suite. Inside
839 Makefiles, the root of your build tree is called
840 <Constant>$(FPTOOLS_TOP)</Constant><IndexTerm><Primary>FPTOOLS_TOP</Primary></IndexTerm>. In the rest of this document path
841 names are relative to <Constant>$(FPTOOLS_TOP)</Constant> unless otherwise stated. For
842 example, the file <Filename>ghc/mk/target.mk</Filename> is actually
843 <Filename><Constant>$(FPTOOLS_TOP)</Constant>/ghc/mk/target.mk</Filename>.
848 <Sect2 id="sec-build-config">
849 <Title>Getting the build you want
853 When you build <Literal>fptools</Literal> you will be compiling code on a particular
854 <Emphasis>host platform</Emphasis>, to run on a particular <Emphasis>target platform</Emphasis>
855 (usually the same as the host platform)<IndexTerm><Primary>platform</Primary></IndexTerm>. The
856 difficulty is that there are minor differences between different
857 platforms; minor, but enough that the code needs to be a bit different
858 for each. There are some big differences too: for a different
859 architecture we need to build GHC with a different native-code
864 There are also knobs you can turn to control how the <Literal>fptools</Literal>
865 software is built. For example, you might want to build GHC optimised
866 (so that it runs fast) or unoptimised (so that you can compile it fast
867 after you've modified it. Or, you might want to compile it with
868 debugging on (so that extra consistency-checking code gets included)
873 All of this stuff is called the <Emphasis>configuration</Emphasis> of your build.
874 You set the configuration using a three-step process.
878 <Term>Step 1: get ready for configuration.</Term>
882 <Constant>$(FPTOOLS_TOP)</Constant> and issue the command <Command>autoconf</Command><IndexTerm><Primary>autoconf</Primary></IndexTerm> (with
883 no arguments). This GNU program converts <Filename><Constant>$(FPTOOLS_TOP)</Constant>/configure.in</Filename>
884 to a shell script called <Filename><Constant>$(FPTOOLS_TOP)</Constant>/configure</Filename>.
888 Some projects, including GHC, have their own configure script. If
890 <Constant>$(FPTOOLS_TOP)/<project>/configure.in</Constant>,
891 then you need to run <command>autoconf</command> in that directory too.
895 Both these steps are completely platform-independent; they just mean
896 that the human-written file (<Filename>configure.in</Filename>) can be short, although
897 the resulting shell script, <Command>configure</Command>, and <Filename>mk/config.h.in</Filename>, are
902 In case you don't have <Command>autoconf</Command> we distribute the results,
903 <Command>configure</Command>, and <Filename>mk/config.h.in</Filename>, with the source distribution. They
904 aren't kept in the repository, though.
906 </ListItem></VarListEntry>
908 <Term>Step 2: system configuration.</Term>
911 Runs the newly-created <Command>configure</Command> script, thus:
917 <Command>configure</Command>'s mission is to scurry round your
918 computer working out what architecture it has, what operating system,
919 whether it has the <Function>vfork</Function> system call, where
920 <Command>yacc</Command> is kept, whether <Command>gcc</Command> is
921 available, where various obscure <Literal>#include</Literal> files
922 are, whether it's a leap year, and what the systems manager had for
923 lunch. It communicates these snippets of information in two ways:
932 It translates <Filename>mk/config.mk.in</Filename><IndexTerm><Primary>config.mk.in</Primary></IndexTerm> to
933 <Filename>mk/config.mk</Filename><IndexTerm><Primary>config.mk</Primary></IndexTerm>, substituting for things between
934 ``<Literal>@</Literal>'' brackets. So, ``<Literal>@HaveGcc@</Literal>'' will be replaced by
935 ``<Literal>YES</Literal>'' or ``<Literal>NO</Literal>'' depending on what <Command>configure</Command> finds.
936 <Filename>mk/config.mk</Filename> is included by every Makefile (directly or indirectly),
937 so the configuration information is thereby communicated to all
945 It translates <Filename>mk/config.h.in</Filename><IndexTerm><Primary>config.h.in</Primary></IndexTerm> to
946 <Filename>mk/config.h</Filename><IndexTerm><Primary>config.h</Primary></IndexTerm>. The latter is <Literal>#include</Literal>d by various C
947 programs, which can thereby make use of configuration information.
957 <Command>configure</Command> caches the results of its run in <Filename>config.cache</Filename>. Quite
958 often you don't want that; you're running <Command>configure</Command> a second time
959 because something has changed. In that case, simply delete
960 <Filename>config.cache</Filename>.
962 </ListItem></VarListEntry>
964 <Term>Step 3: build configuration.</Term>
967 Next, you say how this build of <Literal>fptools</Literal> is to differ from the
968 standard defaults by creating a new file <Filename>mk/build.mk</Filename><IndexTerm><Primary>build.mk</Primary></IndexTerm>
969 <Emphasis>in the build tree</Emphasis>. This file is the one and only file you edit
970 in the build tree, precisely because it says how this build differs
971 from the source. (Just in case your build tree does die, you might
972 want to keep a private directory of <Filename>build.mk</Filename> files, and use a
973 symbolic link in each build tree to point to the appropriate one.) So
974 <Filename>mk/build.mk</Filename> never exists in the source tree—you create one in
975 each build tree from the template. We'll discuss what to put in it
978 </ListItem></VarListEntry>
983 And that's it for configuration. Simple, eh?
987 What do you put in your build-specific configuration file
988 <Filename>mk/build.mk</Filename>? <Emphasis>For almost all purposes all you will do is put
989 make variable definitions that override those in</Emphasis> <Filename>mk/config.mk.in</Filename>.
990 The whole point of <Filename>mk/config.mk.in</Filename>—and its derived counterpart
991 <Filename>mk/config.mk</Filename>—is to define the build configuration. It is heavily
992 commented, as you will see if you look at it. So generally, what you
993 do is look at <Filename>mk/config.mk.in</Filename>, and add definitions in <Filename>mk/build.mk</Filename>
994 that override any of the <Filename>config.mk</Filename> definitions that you want to
995 change. (The override occurs because the main boilerplate file,
996 <Filename>mk/boilerplate.mk</Filename><IndexTerm><Primary>boilerplate.mk</Primary></IndexTerm>, includes <Filename>build.mk</Filename> after
997 <Filename>config.mk</Filename>.)
1001 For example, <Filename>config.mk.in</Filename> contains the definition:
1007 ProjectsToBuild = glafp-utils ghc hslibs
1013 The accompanying comment explains that this is the list of enabled
1014 projects; that is, if (after configuring) you type <Command>gmake all</Command> in
1015 <Constant>FPTOOLS_TOP</Constant> three specified projects will be made. If you want to
1016 add <Command>green-card</Command>, you can add this line to <Filename>build.mk</Filename>:
1022 ProjectsToBuild += green-card
1034 ProjectsToBuild = glafp-utils ghc green-card
1040 (GNU <Command>make</Command> allows existing definitions to have new text appended
1041 using the ``<Literal>+=</Literal>'' operator, which is quite a convenient feature.)
1045 When reading <Filename>config.mk.in</Filename>, remember that anything between
1046 ``@...@'' signs is going to be substituted by <Command>configure</Command>
1047 later. You <Emphasis>can</Emphasis> override the resulting definition if you want,
1048 but you need to be a bit surer what you are doing. For example,
1049 there's a line that says:
1061 This defines the Make variables <Constant>YACC</Constant> to the pathname for a <Command>yacc</Command> that
1062 <Command>configure</Command> finds somewhere. If you have your own pet <Command>yacc</Command> you want
1063 to use instead, that's fine. Just add this line to <Filename>mk/build.mk</Filename>:
1075 You do not <Emphasis>have</Emphasis> to have a <Filename>mk/build.mk</Filename> file at all; if you
1076 don't, you'll get all the default settings from <Filename>mk/config.mk.in</Filename>.
1080 You can also use <Filename>build.mk</Filename> to override anything that <Command>configure</Command> got
1081 wrong. One place where this happens often is with the definition of
1082 <Constant>FPTOOLS_TOP_ABS</Constant>: this variable is supposed to be the canonical path
1083 to the top of your source tree, but if your system uses an automounter
1084 then the correct directory is hard to find automatically. If you find
1085 that <Command>configure</Command> has got it wrong, just put the correct definition in
1086 <Filename>build.mk</Filename>.
1091 <Sect2 id="sec-storysofar">
1092 <Title>The story so far</Title>
1095 Let's summarise the steps you need to carry to get yourself
1096 a fully-configured build tree from scratch.
1105 Get your source tree from somewhere (CVS repository or source
1106 distribution). Say you call the root directory <Filename>myfptools</Filename> (it
1107 does not have to be called <Filename>fptools</Filename>). Make sure that you have
1108 the essential files (see <XRef LinkEnd="sec-source-tree">).
1115 Use <Command>lndir</Command> or <Command>mkshadowdir</Command> to create a build tree.
1119 mkshadowdir . /scratch/joe-bloggs/myfptools-sun4
1122 (N.B. <Command>mkshadowdir</Command>'s first argument is taken relative to its second.) You probably want to give the build tree a name that
1123 suggests its main defining characteristic (in your mind at least),
1124 in case you later add others.
1131 Change directory to the build tree. Everything is going
1132 to happen there now.
1135 cd /scratch/joe-bloggs/myfptools-sun4
1143 Prepare for system configuration:
1149 (You can skip this step if you are starting from a source distribution,
1150 and you already have <Filename>configure</Filename> and <Filename>mk/config.h.in</Filename>.)
1157 Do system configuration:
1169 Create the file <Filename>mk/build.mk</Filename>,
1170 adding definitions for your desired configuration options.
1181 You can make subsequent changes to <Filename>mk/build.mk</Filename> as often
1182 as you like. You do not have to run any further configuration
1183 programs to make these changes take effect.
1184 In theory you should, however, say <Command>gmake clean</Command>, <Command>gmake all</Command>,
1185 because configuration option changes could affect anything—but in practice you are likely to know what's affected.
1191 <Title>Making things</Title>
1194 At this point you have made yourself a fully-configured build tree,
1195 so you are ready to start building real things.
1199 The first thing you need to know is that
1200 <Emphasis>you must use GNU <Command>make</Command>, usually called <Command>gmake</Command>, not standard Unix <Command>make</Command></Emphasis>.
1201 If you use standard Unix <Command>make</Command> you will get all sorts of error messages
1202 (but no damage) because the <Literal>fptools</Literal> <Command>Makefiles</Command> use GNU <Command>make</Command>'s facilities
1208 <Sect2 id="sec-standard-targets">
1209 <Title>Standard Targets
1211 <IndexTerm><Primary>targets, standard makefile</Primary></IndexTerm>
1212 <IndexTerm><Primary>makefile targets</Primary></IndexTerm></Title>
1215 In any directory you should be able to make the following:
1219 <Term><Literal>boot</Literal>:</Term>
1222 does the one-off preparation required to get ready for the real work.
1223 Notably, it does <Command>gmake depend</Command> in all directories that contain
1224 programs. It also builds the necessary tools for compilation to proceed.
1228 You should say <Command>gmake boot</Command> right after configuring your build tree,
1229 but note that this is a one-off, i.e., there's no need to re-do
1230 <Command>gmake boot</Command> if you should re-configure your build tree at a later
1231 stage (no harm caused if you do though).
1233 </ListItem></VarListEntry>
1235 <Term><Literal>all</Literal>:</Term>
1238 makes all the final target(s) for this Makefile.
1239 Depending on which directory you are in a ``final target'' may be an
1240 executable program, a library archive, a shell script, or a Postscript
1241 file. Typing <Command>gmake</Command> alone is generally the same as typing <Command>gmake all</Command>.
1243 </ListItem></VarListEntry>
1245 <Term><Literal>install</Literal>:</Term>
1248 installs the things built by <Literal>all</Literal>. Where does it
1249 install them? That is specified by
1250 <Filename>mk/config.mk.in</Filename>; you can override it in
1251 <Filename>mk/build.mk</Filename>, or by running
1252 <command>configure</command> with command-line arguments like
1253 <literal>--bindir=/home/simonpj/bin</literal>; see <literal>./configure
1254 --help</literal> for the full details.
1256 </ListItem></VarListEntry>
1258 <Term><Literal>uninstall</Literal>:</Term>
1261 reverses the effect of <Literal>install</Literal>.
1263 </ListItem></VarListEntry>
1266 <Term><Literal>clean</Literal>:</Term>
1269 Delete all files from the current directory that are normally
1270 created by building the program. Don't delete the files that
1271 record the configuration. Also preserve files that could be made
1272 by building, but normally aren't because the distribution comes
1274 </ListItem></VarListEntry>
1277 <term><literal>distclean</literal>:</term>
1279 <para>Delete all files from the current directory that are created by
1280 configuring or building the program. If you have unpacked the source
1281 and built the program without creating any other files, <literal>make
1282 distclean</literal> should leave only the files that were in the
1283 distribution.</para>
1288 <term><literal>mostlyclean</literal>:</term>
1290 <para>Like <literal>clean</literal>, but may refrain from deleting a
1291 few files that people normally don't want to recompile.</para>
1296 <Term><Literal>maintainer-clean</Literal>:</Term>
1299 Delete everything from the current directory that can be reconstructed
1300 with this Makefile. This typically includes everything deleted by
1301 <literal>distclean</literal>, plus more: C source files produced by
1302 Bison, tags tables, Info files, and so on.</para>
1304 <para>One exception, however: <literal>make maintainer-clean</literal>
1305 should not delete <filename>configure</filename> even if
1306 <filename>configure</filename> can be remade using a rule in the
1307 <filename>Makefile</filename>. More generally, <literal>make
1308 maintainer-clean</literal> should not delete anything that needs to
1309 exist in order to run <filename>configure</filename> and then begin to
1310 build the program.</para>
1315 <Term><Literal>check</Literal>:</Term>
1320 </ListItem></VarListEntry>
1325 All of these standard targets automatically recurse into
1326 sub-directories. Certain other standard targets do not:
1333 <Term><Literal>configure</Literal>:</Term>
1336 is only available in the root directory
1337 <Constant>$(FPTOOLS_TOP)</Constant>; it has been discussed in <XRef LinkEnd="sec-build-config">.
1339 </ListItem></VarListEntry>
1341 <Term><Literal>depend</Literal>:</Term>
1344 make a <Filename>.depend</Filename> file in each directory that needs
1345 it. This <Filename>.depend</Filename> file contains mechanically-generated dependency
1346 information; for example, suppose a directory contains a Haskell
1347 source module <Filename>Foo.lhs</Filename> which imports another module <Literal>Baz</Literal>.
1348 Then the generated <Filename>.depend</Filename> file will contain the dependency:
1360 which says that the object file <Filename>Foo.o</Filename> depends on the interface file
1361 <Filename>Baz.hi</Filename> generated by compiling module <Literal>Baz</Literal>. The <Filename>.depend</Filename> file is
1362 automatically included by every Makefile.
1364 </ListItem></VarListEntry>
1366 <Term><Literal>binary-dist</Literal>:</Term>
1369 make a binary distribution. This is the
1370 target we use to build the binary distributions of GHC and Happy.
1372 </ListItem></VarListEntry>
1374 <Term><Literal>dist</Literal>:</Term>
1377 make a source distribution. You must be in a
1378 linked build tree to make this target.
1380 </ListItem></VarListEntry>
1385 Most <Filename>Makefile</Filename>s have targets other than these. You can discover them by looking in the <Filename>Makefile</Filename> itself.
1391 <title>Using a project from the build tree</title>
1393 If you want to build GHC (say) and just use it direct from the build
1394 tree without doing <literal>make install</literal> first, you can run
1395 the in-place driver script:
1396 <filename>ghc/driver/ghc-inplace</filename>.
1399 <para> Do <emphasis>NOT</emphasis> use
1400 <filename>ghc/driver/ghc</filename>, or
1401 <filename>ghc/driver/ghc-4.xx</filename>, as these are the scripts
1402 intended for installation, and contain hard-wired paths to the
1403 installed libraries, rather than the libraries in the build tree.
1407 Happy can similarly be run from the build tree, using
1408 <filename>happy/src/happy-inplace</filename>.
1413 <Title>Fast Making <IndexTerm><Primary>fastmake</Primary></IndexTerm>
1414 <IndexTerm><Primary>dependencies, omitting</Primary></IndexTerm>
1415 <IndexTerm><Primary>FAST, makefile
1416 variable</Primary></IndexTerm></Title>
1419 Sometimes the dependencies get in the way: if you've made a small
1420 change to one file, and you're absolutely sure that it won't affect
1421 anything else, but you know that <Command>make</Command> is going to rebuild everything
1422 anyway, the following hack may be useful:
1434 This tells the make system to ignore dependencies and just build what
1435 you tell it to. In other words, it's equivalent to temporarily
1436 removing the <Filename>.depend</Filename> file in the current directory (where
1437 <Command>mkdependHS</Command> and friends store their dependency information).
1441 A bit of history: GHC used to come with a <Command>fastmake</Command> script that did
1442 the above job, but GNU make provides the features we need to do it
1443 without resorting to a script. Also, we've found that fastmaking is
1444 less useful since the advent of GHC's recompilation checker (see the
1445 User's Guide section on "Separate Compilation").
1453 <Title>The <Filename>Makefile</Filename> architecture
1454 <IndexTerm><Primary>makefile architecture</Primary></IndexTerm></Title>
1457 <Command>make</Command> is great if everything works—you type <Command>gmake install</Command> and
1458 lo! the right things get compiled and installed in the right places.
1459 Our goal is to make this happen often, but somehow it often doesn't;
1460 instead some weird error message eventually emerges from the bowels of
1461 a directory you didn't know existed.
1465 The purpose of this section is to give you a road-map to help you figure
1466 out what is going right and what is going wrong.
1470 <Title>A small project</Title>
1473 To get started, let us look at the <Filename>Makefile</Filename> for an imaginary small
1474 <Literal>fptools</Literal> project, <Literal>small</Literal>. Each project in <Literal>fptools</Literal> has its own
1475 directory in <Constant>FPTOOLS_TOP</Constant>, so the <Literal>small</Literal> project will have its own
1476 directory <Constant>FPOOLS_TOP/small/</Constant>. Inside the <Filename>small/</Filename> directory there
1477 will be a <Filename>Makefile</Filename>, looking something like this:
1481 <IndexTerm><Primary>Makefile, minimal</Primary></IndexTerm>
1484 # Makefile for fptools project "small"
1487 include $(TOP)/mk/boilerplate.mk
1489 SRCS = $(wildcard *.lhs) $(wildcard *.c)
1492 include $(TOP)/target.mk
1498 This <Filename>Makefile</Filename> has three sections:
1507 The first section includes
1511 One of the most important
1512 features of GNU <Command>make</Command> that we use is the ability for a <Filename>Makefile</Filename> to
1513 include another named file, very like <Command>cpp</Command>'s <Literal>#include</Literal>
1518 a file of ``boilerplate'' code from the level
1519 above (which in this case will be
1520 <Filename><Constant>FPTOOLS_TOP</Constant>/mk/boilerplate.mk</Filename><IndexTerm><Primary>boilerplate.mk</Primary></IndexTerm>). As its name
1521 suggests, <Filename>boilerplate.mk</Filename> consists of a large quantity of standard
1522 <Filename>Makefile</Filename> code. We discuss this boilerplate in more detail in
1523 <XRef LinkEnd="sec-boiler">.
1524 <IndexTerm><Primary>include, directive in Makefiles</Primary></IndexTerm>
1525 <IndexTerm><Primary>Makefile inclusion</Primary></IndexTerm>
1527 Before the <Literal>include</Literal> statement, you must define the <Command>make</Command> variable
1528 <Constant>TOP</Constant><IndexTerm><Primary>TOP</Primary></IndexTerm> to be the directory containing the <Filename>mk</Filename> directory in
1529 which the <Filename>boilerplate.mk</Filename> file is. It is <Emphasis>not</Emphasis> OK to simply say
1533 include ../mk/boilerplate.mk # NO NO NO
1537 Why? Because the <Filename>boilerplate.mk</Filename> file needs to know where it is, so
1538 that it can, in turn, <Literal>include</Literal> other files. (Unfortunately, when an
1539 <Literal>include</Literal>d file does an <Literal>include</Literal>, the filename is treated relative to
1540 the directory in which <Command>gmake</Command> is being run, not the directory in
1541 which the <Literal>include</Literal>d sits.) In general, <Emphasis>every file <Filename>foo.mk</Filename>
1542 assumes that <Filename><Constant>$(TOP)</Constant>/mk/foo.mk</Filename> refers to itself.</Emphasis> It is up to the
1543 <Filename>Makefile</Filename> doing the <Literal>include</Literal> to ensure this is the case.
1545 Files intended for inclusion in other <Filename>Makefile</Filename>s are written to have
1546 the following property: <Emphasis>after <Filename>foo.mk</Filename> is <Literal>include</Literal>d, it leaves
1547 <Constant>TOP</Constant> containing the same value as it had just before the <Literal>include</Literal>
1548 statement</Emphasis>. In our example, this invariant guarantees that the
1549 <Literal>include</Literal> for <Filename>target.mk</Filename> will look in the same directory as that for
1550 <Filename>boilerplate.mk</Filename>.
1557 The second section defines the following standard <Command>make</Command>
1558 variables: <Constant>SRCS</Constant><IndexTerm><Primary>SRCS</Primary></IndexTerm> (the source files from which is to be
1559 built), and <Constant>HS_PROG</Constant><IndexTerm><Primary>HS_PROG</Primary></IndexTerm> (the executable binary to be
1560 built). We will discuss in more detail what the ``standard
1561 variables'' are, and how they affect what happens, in <XRef LinkEnd="sec-targets">.
1563 The definition for <Constant>SRCS</Constant> uses the useful GNU <Command>make</Command> construct
1564 <Literal>$(wildcard $pat$)</Literal><IndexTerm><Primary>wildcard</Primary></IndexTerm>, which expands to a list of all
1565 the files matching the pattern <Literal>pat</Literal> in the current directory. In
1566 this example, <Constant>SRCS</Constant> is set to the list of all the <Filename>.lhs</Filename> and <Filename>.c</Filename>
1567 files in the directory. (Let's suppose there is one of each,
1568 <Filename>Foo.lhs</Filename> and <Filename>Baz.c</Filename>.)
1575 The last section includes a second file of standard code,
1576 called <Filename>target.mk</Filename><IndexTerm><Primary>target.mk</Primary></IndexTerm>. It contains the rules that tell
1577 <Command>gmake</Command> how to make the standard targets (<Xref LinkEnd="sec-standard-targets">). Why, you ask,
1578 can't this standard code be part of <Filename>boilerplate.mk</Filename>? Good question.
1579 We discuss the reason later, in <Xref LinkEnd="sec-boiler-arch">.
1581 You do not <Emphasis>have</Emphasis> to <Literal>include</Literal> the <Filename>target.mk</Filename> file. Instead, you
1582 can write rules of your own for all the standard targets. Usually,
1583 though, you will find quite a big payoff from using the canned rules
1584 in <Filename>target.mk</Filename>; the price tag is that you have to understand what
1585 canned rules get enabled, and what they do (<Xref LinkEnd="sec-targets">).
1595 In our example <Filename>Makefile</Filename>, most of the work is done by the two
1596 <Literal>include</Literal>d files. When you say <Command>gmake all</Command>, the following things
1606 <Command>gmake</Command> figures out that the object files are <Filename>Foo.o</Filename> and
1607 <Filename>Baz.o</Filename>.
1614 It uses a boilerplate pattern rule to compile <Filename>Foo.lhs</Filename> to
1615 <Filename>Foo.o</Filename> using a Haskell compiler. (Which one? That is set in the
1616 build configuration.)
1623 It uses another standard pattern rule to compile <Filename>Baz.c</Filename> to
1624 <Filename>Baz.o</Filename>, using a C compiler. (Ditto.)
1631 It links the resulting <Filename>.o</Filename> files together to make <Literal>small</Literal>,
1632 using the Haskell compiler to do the link step. (Why not use <Command>ld</Command>?
1633 Because the Haskell compiler knows what standard libraries to link in.
1634 How did <Command>gmake</Command> know to use the Haskell compiler to do the link,
1635 rather than the C compiler? Because we set the variable <Constant>HS_PROG</Constant>
1636 rather than <Constant>C_PROG</Constant>.)
1646 All <Filename>Makefile</Filename>s should follow the above three-section format.
1652 <Title>A larger project</Title>
1655 Larger projects are usually structured into a number of sub-directories,
1656 each of which has its own <Filename>Makefile</Filename>. (In very large projects, this
1657 sub-structure might be iterated recursively, though that is rare.)
1658 To give you the idea, here's part of the directory structure for
1659 the (rather large) GHC project:
1672 ...source files for documentation...
1675 ...source files for driver...
1678 parser/...source files for parser...
1679 renamer/...source files for renamer...
1686 The sub-directories <Filename>docs</Filename>, <Filename>driver</Filename>, <Filename>compiler</Filename>, and so on, each
1687 contains a sub-component of GHC, and each has its own <Filename>Makefile</Filename>.
1688 There must also be a <Filename>Makefile</Filename> in <Filename><Constant>$(FPTOOLS_TOP)</Constant>/ghc</Filename>. It does most
1689 of its work by recursively invoking <Command>gmake</Command> on the <Filename>Makefile</Filename>s in the
1690 sub-directories. We say that <Filename>ghc/Makefile</Filename> is a <Emphasis>non-leaf
1691 <Filename>Makefile</Filename></Emphasis>, because it does little except organise its children,
1692 while the <Filename>Makefile</Filename>s in the sub-directories are all <Emphasis>leaf
1693 <Filename>Makefile</Filename>s</Emphasis>. (In principle the sub-directories might themselves
1694 contain a non-leaf <Filename>Makefile</Filename> and several sub-sub-directories, but
1695 that does not happen in GHC.)
1699 The <Filename>Makefile</Filename> in <Filename>ghc/compiler</Filename> is considered a leaf <Filename>Makefile</Filename> even
1700 though the <Filename>ghc/compiler</Filename> has sub-directories, because these sub-directories
1701 do not themselves have <Filename>Makefile</Filename>s in them. They are just used to structure
1702 the collection of modules that make up GHC, but all are managed by the
1703 single <Filename>Makefile</Filename> in <Filename>ghc/compiler</Filename>.
1707 You will notice that <Filename>ghc/</Filename> also contains a directory <Filename>ghc/mk/</Filename>. It
1708 contains GHC-specific <Filename>Makefile</Filename> boilerplate code. More precisely:
1717 <Filename>ghc/mk/boilerplate.mk</Filename> is included at the top of
1718 <Filename>ghc/Makefile</Filename>, and of all the leaf <Filename>Makefile</Filename>s in the
1719 sub-directories. It in turn <Literal>include</Literal>s the main boilerplate file
1720 <Filename>mk/boilerplate.mk</Filename>.
1728 <Filename>ghc/mk/target.mk</Filename> is <Literal>include</Literal>d at the bottom of
1729 <Filename>ghc/Makefile</Filename>, and of all the leaf <Filename>Makefile</Filename>s in the
1730 sub-directories. It in turn <Literal>include</Literal>s the file <Filename>mk/target.mk</Filename>.
1740 So these two files are the place to look for GHC-wide customisation
1741 of the standard boilerplate.
1746 <Sect2 id="sec-boiler-arch">
1747 <Title>Boilerplate architecture
1748 <IndexTerm><Primary>boilerplate architecture</Primary></IndexTerm>
1752 Every <Filename>Makefile</Filename> includes a <Filename>boilerplate.mk</Filename><IndexTerm><Primary>boilerplate.mk</Primary></IndexTerm> file
1753 at the top, and <Filename>target.mk</Filename><IndexTerm><Primary>target.mk</Primary></IndexTerm> file at the bottom. In
1754 this section we discuss what is in these files, and why there have to
1755 be two of them. In general:
1764 <Filename>boilerplate.mk</Filename> consists of:
1770 <Emphasis>Definitions of millions of <Command>make</Command> variables</Emphasis> that
1771 collectively specify the build configuration. Examples:
1772 <Constant>HC_OPTS</Constant><IndexTerm><Primary>HC_OPTS</Primary></IndexTerm>, the options to feed to the Haskell compiler;
1773 <Constant>NoFibSubDirs</Constant><IndexTerm><Primary>NoFibSubDirs</Primary></IndexTerm>, the sub-directories to enable within the
1774 <Literal>nofib</Literal> project; <Constant>GhcWithHc</Constant><IndexTerm><Primary>GhcWithHc</Primary></IndexTerm>, the name of the Haskell
1775 compiler to use when compiling GHC in the <Literal>ghc</Literal> project.
1781 <Emphasis>Standard pattern rules</Emphasis> that tell <Command>gmake</Command> how to construct one
1789 <Filename>boilerplate.mk</Filename> needs to be <Literal>include</Literal>d at the <Emphasis>top</Emphasis>
1790 of each <Filename>Makefile</Filename>, so that the user can replace the
1791 boilerplate definitions or pattern rules by simply giving a new
1792 definition or pattern rule in the <Filename>Makefile</Filename>. <Command>gmake</Command>
1793 simply takes the last definition as the definitive one.
1795 Instead of <Emphasis>replacing</Emphasis> boilerplate definitions, it is also quite
1796 common to <Emphasis>augment</Emphasis> them. For example, a <Filename>Makefile</Filename> might say:
1804 thereby adding ``<Option>-O</Option>'' to the end of <Constant>SRC_HC_OPTS</Constant><IndexTerm><Primary>SRC_HC_OPTS</Primary></IndexTerm>.
1811 <Filename>target.mk</Filename> contains <Command>make</Command> rules for the standard
1812 targets described in <Xref LinkEnd="sec-standard-targets">. These rules are selectively included,
1813 depending on the setting of certain <Command>make</Command> variables. These
1814 variables are usually set in the middle section of the
1815 <Filename>Makefile</Filename> between the two <Literal>include</Literal>s.
1817 <Filename>target.mk</Filename> must be included at the end (rather than being part of
1818 <Filename>boilerplate.mk</Filename>) for several tiresome reasons:
1825 <Command>gmake</Command> commits target and dependency lists earlier than
1826 it should. For example, <FIlename>target.mk</FIlename> has a rule that looks like
1831 $(HS_PROG) : $(OBJS)
1832 $(HC) $(LD_OPTS) $< -o $@
1836 If this rule was in <Filename>boilerplate.mk</Filename> then <Constant>$(HS_PROG)</Constant><IndexTerm><Primary>HS_PROG</Primary></IndexTerm>
1837 and <Constant>$(OBJS)</Constant><IndexTerm><Primary>OBJS</Primary></IndexTerm> would not have their final values at the
1838 moment <Command>gmake</Command> encountered the rule. Alas, <Command>gmake</Command> takes a snapshot
1839 of their current values, and wires that snapshot into the rule. (In
1840 contrast, the commands executed when the rule ``fires'' are only
1841 substituted at the moment of firing.) So, the rule must follow the
1842 definitions given in the <Filename>Makefile</Filename> itself.
1849 Unlike pattern rules, ordinary rules cannot be overriden or
1850 replaced by subsequent rules for the same target (at least, not without an
1851 error message). Including ordinary rules in <Filename>boilerplate.mk</Filename> would
1852 prevent the user from writing rules for specific targets in specific cases.
1859 There are a couple of other reasons I've forgotten, but it doesn't
1875 <Sect2 id="sec-boiler">
1876 <Title>The main <Filename>mk/boilerplate.mk</Filename> file
1878 <IndexTerm><Primary>boilerplate.mk</Primary></IndexTerm></Title>
1881 If you look at <Filename><Constant>$(FPTOOLS_TOP)</Constant>/mk/boilerplate.mk</Filename> you will find
1882 that it consists of the following sections, each held in a separate
1890 <Term><Filename>config.mk</Filename><IndexTerm><Primary>config.mk</Primary></IndexTerm></Term>
1893 is the build configuration file we
1894 discussed at length in <Xref LinkEnd="sec-build-config">.
1896 </ListItem></VarListEntry>
1898 <Term><Filename>paths.mk</Filename><IndexTerm><Primary>paths.mk</Primary></IndexTerm></Term>
1901 defines <Command>make</Command> variables for
1902 pathnames and file lists. In particular, it gives definitions for:
1909 <Term><Constant>SRCS</Constant><IndexTerm><Primary>SRCS</Primary></IndexTerm>:</Term>
1912 all source files in the current directory.
1914 </ListItem></VarListEntry>
1916 <Term><Constant>HS_SRCS</Constant><IndexTerm><Primary>HS_SRCS</Primary></IndexTerm>:</Term>
1919 all Haskell source files in the current directory.
1920 It is derived from <Constant>$(SRCS)</Constant>, so if you override <Constant>SRCS</Constant> with a new value
1921 <Constant>HS_SRCS</Constant> will follow suit.
1923 </ListItem></VarListEntry>
1925 <Term><Constant>C_SRCS</Constant><IndexTerm><Primary>C_SRCS</Primary></IndexTerm>:</Term>
1928 similarly for C source files.
1930 </ListItem></VarListEntry>
1932 <Term><Constant>HS_OBJS</Constant><IndexTerm><Primary>HS_OBJS</Primary></IndexTerm>:</Term>
1935 the <Filename>.o</Filename> files derived from <Constant>$(HS_SRCS)</Constant>.
1937 </ListItem></VarListEntry>
1939 <Term><Constant>C_OBJS</Constant><IndexTerm><Primary>C_OBJS</Primary></IndexTerm>:</Term>
1942 similarly for <Constant>$(C_SRCS)</Constant>.
1944 </ListItem></VarListEntry>
1946 <Term><Constant>OBJS</Constant><IndexTerm><Primary>OBJS</Primary></IndexTerm>:</Term>
1949 the concatenation of <Constant>$(HS_OBJS)</Constant> and <Constant>$(C_OBJS)</Constant>.
1951 </ListItem></VarListEntry>
1956 Any or all of these definitions can easily be overriden by giving new
1957 definitions in your <Filename>Makefile</Filename>. For example, if there are things in
1958 the current directory that look like source files but aren't, then
1959 you'll need to set <Constant>SRCS</Constant> manually in your <Filename>Makefile</Filename>. The other
1960 definitions will then work from this new definition.
1964 What, exactly, does <Filename>paths.mk</Filename> consider a ``source file'' to be? It's
1965 based on the file's suffix (e.g. <Filename>.hs</Filename>, <Filename>.lhs</Filename>, <Filename>.c</Filename>, <Filename>.lc</Filename>, etc), but
1966 this is the kind of detail that changes, so rather than
1967 enumerate the source suffices here the best thing to do is to look in
1968 <Filename>paths.mk</Filename>.
1970 </ListItem></VarListEntry>
1972 <Term><Filename>opts.mk</Filename><IndexTerm><Primary>opts.mk</Primary></IndexTerm></Term>
1975 defines <Command>make</Command> variables for option
1976 strings to pass to each program. For example, it defines
1977 <Constant>HC_OPTS</Constant><IndexTerm><Primary>HC_OPTS</Primary></IndexTerm>, the option strings to pass to the Haskell
1978 compiler. See <Xref LinkEnd="sec-suffix">.
1980 </ListItem></VarListEntry>
1982 <Term><Filename>suffix.mk</Filename><IndexTerm><Primary>suffix.mk</Primary></IndexTerm></Term>
1985 defines standard pattern rules—see <Xref LinkEnd="sec-suffix">.
1987 </ListItem></VarListEntry>
1992 Any of the variables and pattern rules defined by the boilerplate file
1993 can easily be overridden in any particular <Filename>Makefile</Filename>, because the
1994 boilerplate <Literal>include</Literal> comes first. Definitions after this <Literal>include</Literal>
1995 directive simply override the default ones in <Filename>boilerplate.mk</Filename>.
2000 <Sect2 id="sec-suffix">
2001 <Title>Pattern rules and options
2003 <IndexTerm><Primary>Pattern rules</Primary></IndexTerm></Title>
2006 The file <Filename>suffix.mk</Filename><IndexTerm><Primary>suffix.mk</Primary></IndexTerm> defines standard <Emphasis>pattern
2007 rules</Emphasis> that say how to build one kind of file from another, for
2008 example, how to build a <Filename>.o</Filename> file from a <Filename>.c</Filename> file. (GNU <Command>make</Command>'s
2009 <Emphasis>pattern rules</Emphasis> are more powerful and easier to use than Unix
2010 <Command>make</Command>'s <Emphasis>suffix rules</Emphasis>.)
2014 Almost all the rules look something like this:
2022 $(CC) $(CC_OPTS) -c $< -o $@
2028 Here's how to understand the rule. It says that
2029 <Emphasis>something</Emphasis><Filename>.o</Filename> (say <Filename>Foo.o</Filename>) can be built from
2030 <Emphasis>something</Emphasis><Filename>.c</Filename> (<Filename>Foo.c</Filename>), by invoking the C compiler
2031 (path name held in <Constant>$(CC)</Constant>), passing to it the options
2032 <Constant>$(CC_OPTS)</Constant> and the rule's dependent file of the rule
2033 <Literal>$<</Literal> (<Filename>Foo.c</Filename> in this case), and putting the result in
2034 the rule's target <Literal>$@</Literal> (<Filename>Foo.o</Filename> in this case).
2038 Every program is held in a <Command>make</Command> variable defined in
2039 <Filename>mk/config.mk</Filename>—look in <Filename>mk/config.mk</Filename> for the
2040 complete list. One important one is the Haskell compiler, which is
2041 called <Constant>$(HC)</Constant>.
2045 Every program's options are are held in a <Command>make</Command> variables called
2046 <Constant><prog>_OPTS</Constant>. the <Constant><prog>_OPTS</Constant> variables are defined in
2047 <Filename>mk/opts.mk</Filename>. Almost all of them are defined like this:
2053 CC_OPTS = $(SRC_CC_OPTS) $(WAY$(_way)_CC_OPTS) $($*_CC_OPTS) $(EXTRA_CC_OPTS)
2059 The four variables from which <Constant>CC_OPTS</Constant> is built have the following meaning:
2066 <Term><Constant>SRC_CC_OPTS</Constant><IndexTerm><Primary>SRC_CC_OPTS</Primary></IndexTerm>:</Term>
2069 options passed to all C
2072 </ListItem></VarListEntry>
2074 <Term><Constant>WAY_<way>_CC_OPTS</Constant>:</Term>
2078 compilations for way <Literal><way></Literal>. For example,
2079 <Constant>WAY_mp_CC_OPTS</Constant> gives options to pass to the C compiler when
2080 compiling way <Literal>mp</Literal>. The variable <Constant>WAY_CC_OPTS</Constant> holds
2081 options to pass to the C compiler when compiling the standard way.
2082 (<Xref LinkEnd="sec-ways"> dicusses multi-way
2085 </ListItem></VarListEntry>
2087 <Term><Constant><module>_CC_OPTS</Constant>:</Term>
2091 pass to the C compiler that are specific to module <Literal><module></Literal>. For example, <Constant>SMap_CC_OPTS</Constant> gives the specific options
2092 to pass to the C compiler when compiling <Filename>SMap.c</Filename>.
2094 </ListItem></VarListEntry>
2096 <Term><Constant>EXTRA_CC_OPTS</Constant><IndexTerm><Primary>EXTRA_CC_OPTS</Primary></IndexTerm>:</Term>
2099 extra options to pass to all
2100 C compilations. This is intended for command line use, thus:
2106 gmake libHS.a EXTRA_CC_OPTS="-v"
2110 </ListItem></VarListEntry>
2116 <Sect2 id="sec-targets">
2117 <Title>The main <Filename>mk/target.mk</Filename> file
2119 <IndexTerm><Primary>target.mk</Primary></IndexTerm></Title>
2122 <Filename>target.mk</Filename> contains canned rules for all the standard targets
2123 described in <Xref LinkEnd="sec-standard-targets">. It is complicated by the fact that you don't want all of
2124 these rules to be active in every <Filename>Makefile</Filename>. Rather than have a
2125 plethora of tiny files which you can include selectively, there is a
2126 single file, <Filename>target.mk</Filename>, which selectively includes rules based on
2127 whether you have defined certain variables in your <Filename>Makefile</Filename>. This
2128 section explains what rules you get, what variables control them, and
2129 what the rules do. Hopefully, you will also get enough of an idea of
2130 what is supposed to happen that you can read and understand any weird
2131 special cases yourself.
2138 <Term><Constant>HS_PROG</Constant><IndexTerm><Primary>HS_PROG</Primary></IndexTerm>.</Term>
2141 If <Constant>HS_PROG</Constant> is defined, you get
2142 rules with the following targets:
2146 <Term><Filename>HS_PROG</Filename><IndexTerm><Primary>HS_PROG</Primary></IndexTerm></Term>
2149 itself. This rule links <Constant>$(OBJS)</Constant>
2150 with the Haskell runtime system to get an executable called
2151 <Constant>$(HS_PROG)</Constant>.
2153 </ListItem></VarListEntry>
2155 <Term><Literal>install</Literal><IndexTerm><Primary>install</Primary></IndexTerm></Term>
2158 installs <Constant>$(HS_PROG)</Constant>
2159 in <Constant>$(bindir)</Constant>.
2161 </ListItem></VarListEntry>
2164 </ListItem></VarListEntry>
2166 <Term><Constant>C_PROG</Constant><IndexTerm><Primary>C_PROG</Primary></IndexTerm></Term>
2169 is similar to <Constant>HS_PROG</Constant>, except that
2170 the link step links <Constant>$(C_OBJS)</Constant> with the C runtime system.
2172 </ListItem></VarListEntry>
2174 <Term><Constant>LIBRARY</Constant><IndexTerm><Primary>LIBRARY</Primary></IndexTerm></Term>
2177 is similar to <Constant>HS_PROG</Constant>, except that
2178 it links <Constant>$(LIB_OBJS)</Constant> to make the library archive <Constant>$(LIBRARY)</Constant>, and
2179 <Literal>install</Literal> installs it in <Constant>$(libdir)</Constant>.
2181 </ListItem></VarListEntry>
2183 <Term><Constant>LIB_DATA</Constant><IndexTerm><Primary>LIB_DATA</Primary></IndexTerm></Term>
2188 </ListItem></VarListEntry>
2190 <Term><Constant>LIB_EXEC</Constant><IndexTerm><Primary>LIB_EXEC</Primary></IndexTerm></Term>
2195 </ListItem></VarListEntry>
2197 <Term><Constant>HS_SRCS</Constant><IndexTerm><Primary>HS_SRCS</Primary></IndexTerm>, <Constant>C_SRCS</Constant><IndexTerm><Primary>C_SRCS</Primary></IndexTerm>.</Term>
2200 If <Constant>HS_SRCS</Constant>
2201 is defined and non-empty, a rule for the target <Literal>depend</Literal> is included,
2202 which generates dependency information for Haskell programs.
2203 Similarly for <Constant>C_SRCS</Constant>.
2205 </ListItem></VarListEntry>
2210 All of these rules are ``double-colon'' rules, thus
2216 install :: $(HS_PROG)
2217 ...how to install it...
2223 GNU <Command>make</Command> treats double-colon rules as separate entities. If there
2224 are several double-colon rules for the same target it takes each in
2225 turn and fires it if its dependencies say to do so. This means that
2226 you can, for example, define both <Constant>HS_PROG</Constant> and <Constant>LIBRARY</Constant>, which will
2227 generate two rules for <Literal>install</Literal>. When you type <Command>gmake install</Command> both
2228 rules will be fired, and both the program and the library will be
2229 installed, just as you wanted.
2234 <Sect2 id="sec-subdirs">
2237 <IndexTerm><Primary>recursion, in makefiles</Primary></IndexTerm>
2238 <IndexTerm><Primary>Makefile, recursing into subdirectories</Primary></IndexTerm></Title>
2241 In leaf <Filename>Makefile</Filename>s the variable <Constant>SUBDIRS</Constant><IndexTerm><Primary>SUBDIRS</Primary></IndexTerm> is undefined.
2242 In non-leaf <Filename>Makefile</Filename>s, <Constant>SUBDIRS</Constant> is set to the list of
2243 sub-directories that contain subordinate <Filename>Makefile</Filename>s. <Emphasis>It is up to
2244 you to set <Constant>SUBDIRS</Constant> in the <Filename>Makefile</Filename>.</Emphasis> There is no automation here—<Constant>SUBDIRS</Constant> is too important to automate.
2248 When <Constant>SUBDIRS</Constant> is defined, <Filename>target.mk</Filename> includes a rather
2249 neat rule for the standard targets (<Xref LinkEnd="sec-standard-targets"> that simply invokes
2250 <Command>make</Command> recursively in each of the sub-directories.
2254 <Emphasis>These recursive invocations are guaranteed to occur in the order
2255 in which the list of directories is specified in <Constant>SUBDIRS</Constant>. </Emphasis>This
2256 guarantee can be important. For example, when you say <Command>gmake boot</Command> it
2257 can be important that the recursive invocation of <Command>make boot</Command> is done
2258 in one sub-directory (the include files, say) before another (the
2259 source files). Generally, put the most independent sub-directory
2260 first, and the most dependent last.
2265 <Sect2 id="sec-ways">
2266 <Title>Way management
2268 <IndexTerm><Primary>way management</Primary></IndexTerm></Title>
2271 We sometimes want to build essentially the same system in several
2272 different ``ways''. For example, we want to build GHC's <Literal>Prelude</Literal>
2273 libraries with and without profiling, with and without concurrency,
2274 and so on, so that there is an appropriately-built library archive to
2275 link with when the user compiles his program. It would be possible to
2276 have a completely separate build tree for each such ``way'', but it
2277 would be horribly bureaucratic, especially since often only parts of
2278 the build tree need to be constructed in multiple ways.
2282 Instead, the <Filename>target.mk</Filename><IndexTerm><Primary>target.mk</Primary></IndexTerm> contains some clever magic to
2283 allow you to build several versions of a system; and to control
2284 locally how many versions are built and how they differ. This section
2289 The files for a particular way are distinguished by munging the
2290 suffix. The ``normal way'' is always built, and its files have the
2291 standard suffices <Filename>.o</Filename>, <Filename>.hi</Filename>, and so on. In addition, you can build
2292 one or more extra ways, each distinguished by a <Emphasis>way tag</Emphasis>. The
2293 object files and interface files for one of these extra ways are
2294 distinguished by their suffix. For example, way <Literal>mp</Literal> has files
2295 <Filename>.mp_o</Filename> and <Filename>.mp_hi</Filename>. Library archives have their way tag the other
2296 side of the dot, for boring reasons; thus, <Filename>libHS_mp.a</Filename>.
2300 A <Command>make</Command> variable called <Constant>way</Constant> holds the current way tag. <Emphasis><Constant>way</Constant>
2301 is only ever set on the command line of a recursive invocation of
2302 <Command>gmake</Command>.</Emphasis> It is never set inside a <Filename>Makefile</Filename>. So it is a global
2303 constant for any one invocation of <Command>gmake</Command>. Two other <Command>make</Command>
2304 variables, <Constant>way_</Constant> and <Constant>_way</Constant> are immediately derived from <Constant>$(way)</Constant> and
2305 never altered. If <Constant>way</Constant> is not set, then neither are <Constant>way_</Constant> and
2306 <Constant>_way</Constant>, and the invocation of <Command>make</Command> will build the ``normal way''.
2307 If <Constant>way</Constant> is set, then the other two variables are set in sympathy.
2308 For example, if <Constant>$(way)</Constant> is ``<Literal>mp</Literal>'', then <Constant>way_</Constant> is set to ``<Literal>mp_</Literal>''
2309 and <Constant>_way</Constant> is set to ``<Literal>_mp</Literal>''. These three variables are then used
2310 when constructing file names.
2314 So how does <Command>make</Command> ever get recursively invoked with <Constant>way</Constant> set? There
2315 are two ways in which this happens:
2324 For some (but not all) of the standard targets, when in a leaf
2325 sub-directory, <Command>make</Command> is recursively invoked for each way tag in
2326 <Constant>$(WAYS)</Constant>. You set <Constant>WAYS</Constant> to the list of way tags you want these
2327 targets built for. The mechanism here is very much like the recursive
2328 invocation of <Command>make</Command> in sub-directories (<Xref LinkEnd="sec-subdirs">).
2330 It is up to you to set <Constant>WAYS</Constant> in your <Filename>Makefile</Filename>; this is how you
2331 control what ways will get built.
2337 For a useful collection of
2338 targets (such as <Filename>libHS_mp.a</Filename>, <Filename>Foo.mp_o</Filename>) there is a rule which
2339 recursively invokes <Command>make</Command> to make the specified target, setting the
2340 <Constant>way</Constant> variable. So if you say <Command>gmake Foo.mp_o</Command> you should see a
2341 recursive invocation <Command>gmake Foo.mp_o way=mp</Command>, and <Emphasis>in this
2342 recursive invocation the pattern rule for compiling a Haskell file
2343 into a <Filename>.o</Filename> file will match</Emphasis>. The key pattern rules (in <Filename>suffix.mk</Filename>)
2349 $(HC) $(HC_OPTS) $< -o $@
2364 <Title>When the canned rule isn't right</Title>
2367 Sometimes the canned rule just doesn't do the right thing. For
2368 example, in the <Literal>nofib</Literal> suite we want the link step to print out
2369 timing information. The thing to do here is <Emphasis>not</Emphasis> to define
2370 <Constant>HS_PROG</Constant> or <Constant>C_PROG</Constant>, and instead define a special purpose rule in
2371 your own <Filename>Makefile</Filename>. By using different variable names you will avoid
2372 the canned rules being included, and conflicting with yours.
2379 <Sect1 id="sec-booting-from-C">
2380 <Title>Booting/porting from C (<Filename>.hc</Filename>) files
2382 <IndexTerm><Primary>building GHC from .hc files</Primary></IndexTerm>
2383 <IndexTerm><Primary>booting GHC from .hc files</Primary></IndexTerm>
2384 <IndexTerm><Primary>porting GHC</Primary></IndexTerm></Title>
2387 This section is for people trying to get GHC going by using the
2388 supplied intermediate C (<Filename>.hc</Filename>) files. This would probably be because
2389 no binaries have been provided, or because the machine is not ``fully
2394 The intermediate C files are normally made available together with a
2395 source release, please check the announce message for exact directions
2396 of where to find them. If we haven't made them available or you
2397 can't find them, please ask.
2401 Assuming you've got them, unpack them on top of a fresh source tree.
2402 Then follow the `normal' instructions in <Xref LinkEnd="sec-building-from-source"> for setting
2403 up a build tree. When you invoke the configure script, you'll have
2404 to tell the script about your intentions:
2410 foo% ./configure --enable-hc-boot
2413 <IndexTerm><Primary>--enable-hc-boot</Primary></IndexTerm>
2414 <IndexTerm><Primary>--disable-hc-boot</Primary></IndexTerm>
2418 Assuming it configures OK and you don't need to create <Filename>mk/build.mk</Filename>
2419 for any other purposes, the next step is to proceed with a <Command>make boot</Command>
2420 followed by <Command>make all</Command>. At the successful completion of <Command>make all</Command>,
2421 you should end up with a binary of the compiler proper,
2422 <Filename>ghc/compiler/hsc</Filename>, plus archives (but no <Filename>.hi</Filename> files!) of the prelude
2423 libraries. To generate the Prelude interface files (and test drive the
2424 bootstrapped compiler), re-run the <Command>configure</Command> script, but this time
2425 without the <Option>--enable-hc-boot</Option> option. After that re-create the
2426 contents of <Filename>ghc/lib</Filename>:
2443 That's the mechanics of the boot process, but, of course, if you're
2444 trying to boot on a platform that is not supported and significantly
2445 `different' from any of the supported ones, this is only the start of
2446 the adventure…(ToDo: porting tips—stuff to look out for, etc.)
2451 <Sect1 id="sec-build-pitfalls">
2452 <Title>Known pitfalls in building Glasgow Haskell
2454 <IndexTerm><Primary>problems, building</Primary></IndexTerm>
2455 <IndexTerm><Primary>pitfalls, in building</Primary></IndexTerm>
2456 <IndexTerm><Primary>building pitfalls</Primary></IndexTerm></Title>
2459 WARNINGS about pitfalls and known ``problems'':
2468 One difficulty that comes up from time to time is running out of space
2469 in <Filename>/tmp</Filename>. (It is impossible for the configuration stuff to
2470 compensate for the vagaries of different sysadmin approaches to temp
2472 <IndexTerm><Primary>tmp, running out of space in</Primary></IndexTerm>
2474 The quickest way around it is <Command>setenv TMPDIR /usr/tmp</Command><IndexTerm><Primary>TMPDIR</Primary></IndexTerm> or
2475 even <Command>setenv TMPDIR .</Command> (or the equivalent incantation with your shell
2478 The best way around it is to say
2481 export TMPDIR=<dir>
2484 in your <Filename>build.mk</Filename> file.
2485 Then GHC and the other <Literal>fptools</Literal> programs will use the appropriate directory
2494 In compiling some support-code bits, e.g., in <Filename>ghc/rts/gmp</Filename> and even
2495 in <Filename>ghc/lib</Filename>, you may get a few C-compiler warnings. We think these
2503 When compiling via C, you'll sometimes get ``warning: assignment from
2504 incompatible pointer type'' out of GCC. Harmless.
2511 Similarly, <Command>ar</Command>chiving warning messages like the following are not
2515 ar: filename GlaIOMonad__1_2s.o truncated to GlaIOMonad_
2516 ar: filename GlaIOMonad__2_2s.o truncated to GlaIOMonad_
2526 In compiling the compiler proper (in <Filename>compiler/</Filename>), you <Emphasis>may</Emphasis>
2527 get an ``Out of heap space'' error message. These can vary with the
2528 vagaries of different systems, it seems. The solution is simple:
2535 If you're compiling with GHC 4.00 or later, then the
2536 <Emphasis>maximum</Emphasis> heap size must have been reached. This
2537 is somewhat unlikely, since the maximum is set to 64M by default.
2538 Anyway, you can raise it with the
2539 <Option>-optCrts-M<size></Option> flag (add this flag to
2540 <Constant><module>_HC_OPTS</Constant>
2541 <Command>make</Command> variable in the appropriate
2542 <Filename>Makefile</Filename>).
2549 For GHC < 4.00, add a suitable <Option>-H</Option> flag to the <Filename>Makefile</Filename>, as
2558 and try again: <Command>gmake</Command>. (see <Xref LinkEnd="sec-suffix"> for information about
2559 <Constant><module>_HC_OPTS</Constant>.)
2561 Alternatively, just cut to the chase:
2565 % make EXTRA_HC_OPTS=-optCrts-M128M
2574 If you try to compile some Haskell, and you get errors from GCC about
2575 lots of things from <Filename>/usr/include/math.h</Filename>, then your GCC was
2576 mis-installed. <Command>fixincludes</Command> wasn't run when it should've been.
2578 As <Command>fixincludes</Command> is now automagically run as part of GCC installation,
2579 this bug also suggests that you have an old GCC.
2587 You <Emphasis>may</Emphasis> need to re-<Command>ranlib</Command><IndexTerm><Primary>ranlib</Primary></IndexTerm> your libraries (on Sun4s).
2591 % cd $(libdir)/ghc-x.xx/sparc-sun-sunos4
2592 % foreach i ( `find . -name '*.a' -print` ) # or other-shell equiv...
2594 ? # or, on some machines: ar s $i
2599 We'd be interested to know if this is still necessary.
2607 GHC's sources go through <Command>cpp</Command> before being compiled, and <Command>cpp</Command> varies
2608 a bit from one Unix to another. One particular gotcha is macro calls
2613 SLIT("Hello, world")
2617 Some <Command>cpp</Command>s treat the comma inside the string as separating two macro
2618 arguments, so you get
2622 :731: macro `SLIT' used with too many (2) args
2626 Alas, <Command>cpp</Command> doesn't tell you the offending file!
2628 Workaround: don't put weird things in string args to <Command>cpp</Command> macros.
2639 <Sect1 id="winbuild"><Title>Notes for building under Windows</Title>
2642 This section summarises how to get the utilities you need on your
2643 Win95/98/NT/2000 machine to use CVS and build GHC. Similar notes for installing and running GHC may be found in the user guide. In general, Win95/Win98 behave the same, and WinNT/Win2k behave the same. It is based largely on detailed advice from Sigbjørn Finne.
2647 <Sect2><Title>Installing ssh</Title>
2653 Extract the whole of <ULink URL="http://research.microsoft.com/~simonpj/ssh-1_2_26-cygwinb19.tar.gz">the ssh archive</ULink> into your <Filename>C:\</Filename> directory, and use the ``All files'' and ``User folder names'' options in WinZip extract dialogue box. This populates your <Filename>C:\usr\local</Filename> tree.
2659 Extract <ULink URL="http://research.microsoft.com/~simonpj/cygwinb19.dll.zip">cygwinb19.dll</ULink> into <Filename>/usr/local/bin</Filename>. The current version
2660 of Cywin is b20, but this version of ssh was compiled with b19.
2666 On a Win2k machine, open up a bash and do
2671 foo$ mkpasswd -l > passwd
2675 Check that your login entry is on the first line
2676 of that file. If not, move it to the top. It's OK
2677 for 'Administrator' to be the first entry, assuming you are one.
2681 However, Win9x doesn't support the calls that <Command>mkpasswd</Command> relies on
2682 (e.g., <Function>NetUserEnum</Function>). If you run <Command>mkpasswd</Command> you
2687 linked to missing export netapi32.dll:NetUserEnum
2691 The passwd file is used
2692 by ssh in a fairly rudimentary manner, so I'd simply
2693 synthesise/copy an existing Unix <Filename>/etc/passwd</Filename>, i.e., create
2694 an <Filename>/etc/passwd</Filename> file containing the line
2698 <login>::500:513:::/bin/sh
2702 where <Literal><login></Literal> is your login id.
2708 Generate a key, by running <Filename>c:/user/local/bin/ssh-keygen1</Filename>.
2709 This generates a public key in <Filename>.ssh/identity.pub</Filename>, and a
2710 private key in <Filename>.ssh/identity</Filename>
2714 In response to the 'Enter passphrase' question, just hit
2715 return (i.e. use an empty passphrase). The passphrase is
2716 a password that protects your private key. But it's a pain
2717 to type this passphrase everytime you use <Command>ssh</Command>, so the best
2718 thing to do is simply to protect your <Filename>.ssh</Filename> directory, and
2719 <Filename>.ssh/identity</Filename> from access by anyone else. To do this
2720 right-click your <Filename>.ssh</Filename> directory, and select Properties.
2721 If you are not on the access control list, add yourself, and
2722 give yourself full permissions (the second panel).
2723 Remove everyone else from the access control list. (Don't
2724 leave them there but deny them access, because 'they' may be
2725 a list that includes you!)
2729 If you have problems running <Command>ssh-keygen1</Command>
2730 from within <Command>bash</Command>, start up <Filename>cmd.exe</Filename> and run it as follows:
2734 c:\tmp> set CYGWIN32=tty
2735 c:\tmp> c:/user/local/bin/ssh-keygen1
2741 If you don't have an account on <Literal>cvs.haskell.org</Literal>, send
2742 your <Filename>.ssh/identity.pub</Filename> to the CVS repository administrator
2743 (currently Jeff Lewis <Email>jlewis@cse.ogi.edu</Email>). He will set up
2748 If you do have an account on <Literal>cvs.haskell.org</Literal>, use TeraTerm
2749 to logon to it. Once in, copy the
2750 key that <Command>ssh-keygen1</Command> deposited in <Filename>/.ssh/identity.pub</Filename> into
2751 your <Filename>~/.ssh/authorized_keys</Filename>. Make sure that the new version
2752 of <Filename>authorized_keys</Filename> still has 600 file permission.
2761 <Sect2><Title>Installing CVS</Title>
2768 <ULink URL="http://research.microsoft.com/~simonpj/cvs-1_10-win.zip">
2769 CVS</ULink> and, following the instructions in the <Filename>README</Filename>, copy the
2770 appropriate files into <Filename>/usr/local/bin</Filename>.
2776 From the System control panel,
2777 set the following <Emphasis>user</Emphasis> environment variables (see the GHC user guide)
2783 <Constant>HOME</Constant>: points to your home directory. This is where CVS
2784 will look for its <Filename>.cvsrc</Filename> file.
2790 <Constant>CVS_RSH</Constant>: <Filename>c:/usr/local/bin/ssh1</Filename>
2796 <Constant>CVSROOT</Constant>: <Literal>:ext:username@cvs.haskell.org:/home/cvs/root</Literal>,
2797 where <Literal>username</Literal> is your userid
2803 <Constant>CVSEDITOR</Constant>: <Filename>bin/gnuclient.exe</Filename> if you want to use an Emacs buffer for typing in those long commit messages.
2811 Put the following in <Filename>$HOME/.cvsrc</Filename>:
2822 These are the default options for the specified CVS commands,
2823 and represent better defaults than the usual ones. (Feel
2824 free to change them.)
2828 Filenames starting with "<Filename>.</Filename>" were illegal in
2829 the 8.3 DOS filesystem, but that restriction should have
2830 been lifted by now (i.e., you're using VFAT or later filesystems.) If
2831 you're still having problems creating it, don't worry; <Filename>.cvsrc</Filename> is entirely
2838 Try doing <Command>cvs co fpconfig</Command>. All being well, bytes should
2839 start to trickle through, leaving a directory <Filename>fptools</Filename>
2840 in your current directory. (You can <Command>rm</Command> it if you don't want to keep it.) The following messages appear to be harmless:
2844 setsockopt IPTOS_LOWDELAY: Invalid argument
2845 setsockopt IPTOS_THROUGHPUT: Invalid argument
2849 At this point I found that CVS tried to invoke a little dialogue with
2850 me (along the lines of `do you want to talk to this host'), but
2851 somehow bombed out. This was from a bash shell running in emacs.
2852 I solved this by invoking a Cygnus shell, and running CVS from there.
2853 Once things are dialogue free, it seems to work OK from within emacs.
2859 If you want to check out part of large tree, proceed as follows:
2863 cvs -f checkout -l papers
2869 This sequence checks out the <Literal>papers</Literal> module, but none
2870 of its sub-directories.
2871 The "<Option>-l</Option>" flag says not to check out sub-directories.
2872 The "<Option>-f</Option>" flag says not to read the <Filename>.cvsrc</Filename> file
2873 whose <Option>-P</Option> default (don't check out empty directories) is
2878 The <Command>cvs update</Command> command sucks in a named sub-directory.
2885 There is a very nice graphical front-end to CVS for Win32 platforms,
2886 with a UI that people will be familiar with, at
2887 <ULink URL="http://www.wincvs.org/">wincvs.org</ULink>.
2888 I have not tried it yet.
2894 <Sect2><Title>Installing autoconf</Title>
2897 Only required if you are doing builds from GHC's sources
2898 checked out from the CVS tree.
2904 Fetch the (standard, Unix) <Command>autoconf</Command> distribution from
2905 <ULink URL="ftp://ftp.gnu.org/gnu/autoconf">ftp.gnu.org</ULink>.
2910 Unpack it into an arbitrary directory.
2915 Make sure that the directory <Filename>/usr/local/bin</Filename> exists.
2920 Say "<Filename>./configure</Filename>".
2925 Now <Command>make install</Command>. This should put <Filename>autoheader</Filename>
2926 and <Filename>autoconf</Filename> in <Filename>/usr/local/bin</Filename>.
2932 <Command>autoheader</Command> doesn't seem to work, but you don't need it
2939 <Sect2><Title>Building GHC</Title>
2945 In the <Filename>./configure</Filename> output, ignore
2947 checking whether #! works in shell scripts...
2948 ./configure: ./conftest: No such file or directory</Literal>",
2949 and "<Literal>not updating unwritable cache ./config.cache</Literal>".
2950 Nobody knows why these happen, but they seem to be harmless.
2956 You have to run <Command>autoconf</Command> both in <Filename>fptools</Filename>
2957 and in <Filename>fptools/ghc</Filename>. If you omit the latter step you'll
2958 get an error when you run <Filename>./configure</Filename>:
2963 creating mk/config.h
2964 mk/config.h is unchanged
2966 running /bin/sh ./configure --cache-file=.././config.cache --srcdir=.
2967 ./configure: ./configure: No such file or directory
2968 configure: error: ./configure failed for ghc
2974 You need <Filename>ghc</Filename> to be in your <Constant>PATH</Constant> before you run
2975 <Command>configure</Command>. The default GHC InstallShield creates only
2976 <Filename>ghc-4.05</Filename>, so you may need to duplicate this file as <Filename>ghc</Filename>
2977 in the same directory, in order that <Command>configure</Command> will see it (or
2978 just rename <Filename>ghc-4.05</Filename> to <Filename>ghc</Filename>.
2979 And make sure that the directory is in your path.
2985 Compile <Command>happy</Command> and <Command>ghc</Command>
2986 with <Option>-static</Option>. To do this, set
2995 in your <Filename>build.mk</Filename> file.
2996 [Actually, I successfully compiled Happy without <Option>-static</Option> on Win2k, but not GHC.]
projects / ghc-hetmet.git / blob