docs/building.sgml

   1 <!DOCTYPE Article PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
   2
   3 <Article id="building-guide">
   4
   5 <ArtHeader>
   6
   7 <Title>Building the Glasgow Functional Programming Tools Suite</Title>
   8 <Author><OtherName>The GHC Team</OtherName></Author>
   9 <Address><Email>glasgow-haskell-&lcub;users,bugs&rcub;@haskell.org</Email></Address>
  10 <PubDate>January 2000</PubDate>
  11
  12 <Abstract>
  13
  14 <Para>
  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.
  18 </Para>
  19
  20 <Para>
  21 The bulk of this guide applies to building on Unix systems; see <XRef LinkEnd="winbuild"> for Windows notes.
  22 </Para>
  23
  24 </Abstract>
  25
  26 </ArtHeader>
  27
  28
  29 <Sect1 id="sec-getting">
  30 <Title>Getting the Glasgow <Literal>fptools</Literal> suite
  31 </Title>
  32
  33 <Para>
  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!
  38 </Para>
  39
  40 <Para>
  41 Happily, such complications don't apply to most people.  A few common
  42 ``strategies'' serve most purposes.  Pick one and proceed
  43 as suggested:
  44 </Para>
  45
  46 <Para>
  47 <VariableList>
  48
  49 <VarListEntry>
  50 <Term><IndexTerm><Primary>Binary distribution</Primary></IndexTerm>Binary distribution.</Term>
  51 <ListItem>
  52 <Para>
  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.
  58 </Para>
  59
  60 <Para>
  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
  67 off.
  68 </Para>
  69
  70 <Para>
  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.
  73 </Para>
  74 </ListItem></VarListEntry>
  75 <VarListEntry>
  76 <Term><IndexTerm><Primary>Source distribution</Primary></IndexTerm>Source distribution.</Term>
  77 <ListItem>
  78 <Para>
  79 You have a supported
  80 platform, but (a)&nbsp;you like the warm fuzzy feeling of compiling things
  81 yourself; (b)&nbsp;you want to build something ``extra''&mdash;e.g., a set of
  82 libraries with strictness-analysis turned off; or (c)&nbsp;you want to hack
  83 on GHC yourself.
  84 </Para>
  85
  86 <Para>
  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.
  96 </Para>
  97
  98 <Para>
  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.
 103 </Para>
 104
 105 <Para>
 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
 109 later.
 110 </Para>
 111 </ListItem></VarListEntry>
 112 <VarListEntry>
 113 <Term>Build GHC from intermediate C <Filename>.hc</Filename> files<IndexTerm><Primary>hc files</Primary></IndexTerm>:</Term>
 114 <ListItem>
 115 <Para>
 116 You
 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">.
 122 </Para>
 123
 124 <Para>
 125 Once you have built GHC, you can build the other Glasgow tools with
 126 it.
 127 </Para>
 128
 129 <Para>
 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).
 133 </Para>
 134 </ListItem></VarListEntry>
 135 <VarListEntry>
 136 <Term>The CVS repository.</Term>
 137 <ListItem>
 138 <Para>
 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
 142 our CVS repository.
 143 </Para>
 144
 145 <Para>
 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
 148 the network.
 149 </Para>
 150
 151 <Para>
 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.
 156 </Para>
 157
 158 <Para>
 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 >.
 162 </Para>
 163 </ListItem></VarListEntry>
 164 </VariableList>
 165 </Para>
 166
 167 <Para>
 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
 170 manual in detail.
 171 </Para>
 172
 173 </Sect1>
 174
 175 <Sect1 id="sec-build-checks">
 176 <Title>Things to check before you start typing</Title>
 177
 178 <Para>
 179 Here's a list of things to check before you get started.
 180
 181 <OrderedList>
 182 <ListItem>
 183
 184 <Para>
 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.)
 193 </Para>
 194 </ListItem>
 195 <ListItem>
 196
 197 <Para>
 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.
 205 </Para>
 206 </ListItem>
 207 <ListItem>
 208
 209 <Para>
 210  Be sure that the ``pre-supposed'' utilities are installed.
 211 <Xref LinkEnd="sec-pre-supposed"> elaborates.
 212
 213 </Para>
 214 </ListItem>
 215 <ListItem>
 216
 217 <Para>
 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
 223 site</ULink>.
 224
 225 <IndexTerm><Primary>known bugs</Primary></IndexTerm>
 226 <IndexTerm><Primary>bugs, known</Primary></IndexTerm>
 227
 228 If you feel there is still some shortcoming in our procedure or
 229 instructions, please report it.
 230
 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>
 234
 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>
 238 </Para>
 239 </ListItem>
 240
 241 </OrderedList>
 242
 243 </Para>
 244
 245 </Sect1>
 246
 247 <Sect1 id="sec-port-info">
 248 <Title>What machines the Glasgow tools run on
 249 </Title>
 250
 251 <Para>
 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
 257 your platform.
 258 </Para>
 259
 260 <Para>
 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>.
 267 </Para>
 268
 269 <Para>
 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.
 272 </Para>
 273
 274 <Para>
 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.
 278 </Para>
 279
 280 <Sect2>
 281 <Title>What platforms the Haskell compiler (GHC) runs on</Title>
 282
 283 <Para>
 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)&nbsp;Best is a native-code
 289 generator; (b)&nbsp;next best is a ``registerised''
 290 port; (c)&nbsp;the bare minimum is an ``unregisterised'' port.
 291 (``Unregisterised'' is so terrible that we won't say more about it).
 292 </Para>
 293
 294 <Para>
 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.
 297 </Para>
 298
 299 <Para>
 300 We use Sparcs running Solaris 2.7 and x86 boxes running FreeBSD and
 301 Linux, so those are the best supported platforms, unsurprisingly.
 302 </Para>
 303
 304 <Para>
 305 Here's everything that's known about GHC ports.  We identify platforms
 306 by their ``canonical'' CPU/Manufacturer/OS triple.
 307 </Para>
 308
 309 <Para>
 310 <VariableList>
 311
 312 <VarListEntry>
 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>
 319 <ListItem>
 320
 321 <Para>
 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.
 328 </Para>
 329
 330 </ListItem></VarListEntry>
 331 <VarListEntry>
 332 <Term>sparc-sun-sunos4:</Term>
 333 <IndexTerm><Primary>sparc-sun-sunos4</Primary></IndexTerm>
 334 <ListItem>
 335
 336 <Para>
 337 Probably works with minor tweaks, hasn't been tested for a while.
 338 </Para>
 339
 340 </ListItem></VarListEntry>
 341 <VarListEntry>
 342 <Term>sparc-sun-solaris2:</Term>
 343 <IndexTerm><Primary>sparc-sun-solaris2</Primary></IndexTerm>
 344 <ListItem>
 345
 346 <Para>
 347 Fully supported, including native-code generator.
 348 </Para>
 349
 350 </ListItem></VarListEntry>
 351 <VarListEntry>
 352 <Term>hppa1.1-hp-hpux (HP-PA boxes running HPUX 9.x)</Term>
 353 <IndexTerm><Primary>hppa1.1-hp-hpux</Primary></IndexTerm>
 354 <ListItem>
 355
 356 <Para>
 357 Works registerised.  No native-code generator.
 358 </Para>
 359
 360 </ListItem></VarListEntry>
 361 <VarListEntry>
 362 <Term>i386-unknown-linux (PCs running Linux&mdash;ELF binary format):</Term>
 363 <IndexTerm><Primary>i386-*-linux</Primary></IndexTerm>
 364 <ListItem>
 365
 366 <Para>
 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.
 373 </Para>
 374
 375 </ListItem></VarListEntry>
 376 <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>
 382 <ListItem>
 383
 384 <Para>
 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
 387 the package.
 388 </Para>
 389
 390 </ListItem></VarListEntry>
 391 <VarListEntry>
 392 <Term>i386-unknown-cygwin32:</Term>
 393 <IndexTerm><Primary>i386-unknown-cygwin32</Primary></IndexTerm>
 394 <ListItem>
 395
 396 <Para>
 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
 400 etc.).
 401 </Para>
 402
 403 </ListItem></VarListEntry>
 404 <VarListEntry>
 405 <Term>mips-sgi-irix5:</Term>
 406 <IndexTerm><Primary>mips-sgi-irix[5-6]</Primary></IndexTerm>
 407 <ListItem>
 408
 409 <Para>
 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.
 413 </Para>
 414 </ListItem></VarListEntry>
 415
 416 <VarListEntry>
 417 <Term>powerpc-ibm-aix:</Term>
 418 <ListItem>
 419 <Para>
 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.
 424 </Para>
 425 </ListItem></VarListEntry>
 426
 427 </VariableList>
 428 </Para>
 429
 430 <para>
 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
 434 task.
 435 </para>
 436
 437 </Sect2>
 438
 439 <Sect2>
 440 <Title>What machines the other tools run on</Title>
 441
 442 <Para>
 443 Unless you hear otherwise, the other tools work if GHC works.
 444 </Para>
 445
 446 </Sect2>
 447
 448 </Sect1>
 449
 450
 451 <Sect1 id="sec-pre-supposed">
 452 <Title>Installing pre-supposed utilities
 453
 454 <IndexTerm><Primary>pre-supposed utilities</Primary></IndexTerm>
 455 <IndexTerm><Primary>utilities, pre-supposed</Primary></IndexTerm></Title>
 456
 457 <Para>
 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.
 465 </Para>
 466
 467 <Para>
 468 <VariableList>
 469
 470 <VarListEntry>
 471 <Term>Perl:</Term>
 472 <IndexTerm><Primary>pre-supposed: Perl</Primary></IndexTerm>
 473 <IndexTerm><Primary>Perl, pre-supposed</Primary></IndexTerm>
 474 <ListItem>
 475 <Para>
 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.
 479 </Para>
 480
 481 <Para>
 482 Perl&nbsp;5 is required.  For Win32 platforms, we strongly suggest you
 483 pick up a port of Perl&nbsp;5 for <Literal>cygwin32</Literal>, as the
 484 common Hip/ActiveWare port of Perl is Not Cool Enough for our
 485 purposes.
 486 </Para>
 487
 488 <Para>
 489 Perl should be put somewhere so that it can be invoked by the
 490 <Literal>&num;!</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
 494 systems.
 495 </Para>
 496
 497 </ListItem></VarListEntry>
 498 <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>
 502 <ListItem>
 503
 504 <Para>
 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.
 510 </Para>
 511
 512 <Para>
 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&mdash;you may need to fiddle with GHC's
 516 <Option>-monly-N-regs</Option> option; see the User's Guide)
 517 </Para>
 518 </ListItem></VarListEntry>
 519
 520 <varlistentry>
 521 <term>Happy:</term>
 522 <indexterm><primary>Happy</primary></indexterm>
 523 <listitem>
 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>.
 532 </para>
 533 </listitem>
 534 </varlistentry>
 535
 536 <VarListEntry>
 537 <Term>Autoconf:</Term>
 538 <IndexTerm><Primary>pre-supposed: Autoconf</Primary></IndexTerm>
 539 <IndexTerm><Primary>Autoconf, pre-supposed</Primary></IndexTerm>
 540 <ListItem>
 541 <Para>
 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.
 545 </Para>
 546
 547 <Para>
 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>.
 552 </Para>
 553
 554 </ListItem></VarListEntry>
 555 <VarListEntry>
 556 <Term><Command>sed</Command></Term>
 557 <IndexTerm><Primary>pre-supposed: sed</Primary></IndexTerm>
 558 <IndexTerm><Primary>sed, pre-supposed</Primary></IndexTerm>
 559 <ListItem>
 560 <Para>
 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.)
 566 </Para>
 567 </ListItem></VarListEntry>
 568 </VariableList>
 569 </Para>
 570
 571 <Para>
 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.
 577 </Para>
 578
 579 <Sect2 id="pre-supposed-gph-tools">
 580 <Title>Tools for building parallel GHC (GPH)
 581 </Title>
 582
 583 <Para>
 584 <VariableList>
 585
 586 <VarListEntry>
 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>
 590 <ListItem>
 591
 592 <Para>
 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).
 598 </Para>
 599
 600 <Para>
 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>.
 604 </Para>
 605
 606 <Para>
 607 A PVM installation is slightly quirky, but easy to do.  Just follow
 608 the <Filename>Readme</Filename> instructions.
 609 </Para>
 610 </ListItem></VarListEntry>
 611 <VarListEntry>
 612 <Term><Command>bash</Command>:</Term>
 613 <IndexTerm><Primary>bash, presupposed (Parallel Haskell only)</Primary></IndexTerm>
 614 <ListItem>
 615 <Para>
 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).
 619 </Para>
 620 </ListItem></VarListEntry>
 621 </VariableList>
 622 </Para>
 623
 624 </Sect2>
 625
 626 <Sect2 id="pre-supposed-doc-tools">
 627 <Title>Tools for building the Documentation
 628 </Title>
 629
 630 <Para>
 631 The following additional tools are required if you want to format the
 632 documentation that comes with the <Literal>fptools</Literal> projects:
 633 </Para>
 634
 635 <Para>
 636 <VariableList>
 637
 638 <VarListEntry>
 639 <Term>DocBook:</Term>
 640 <IndexTerm><Primary>pre-supposed: DocBook</Primary></IndexTerm>
 641 <IndexTerm><Primary>DocBook, pre-supposed</Primary></IndexTerm>
 642 <ListItem>
 643 <Para>
 644 All our documentation is written in SGML, using the DocBook DTD.
 645 Instructions on installing and configuring the DocBook tools are in the
 646 installation guide (in the GHC user guide).
 647 </Para>
 648
 649 </ListItem></VarListEntry>
 650 <VarListEntry>
 651 <Term>TeX:</Term>
 652 <IndexTerm><Primary>pre-supposed: TeX</Primary></IndexTerm>
 653 <IndexTerm><Primary>TeX, pre-supposed</Primary></IndexTerm>
 654 <ListItem>
 655 <Para>
 656 A decent TeX distribution is required if you want to produce printable
 657 documentation.  We recomment teTeX, which includes just about
 658 everything you need.
 659 </Para>
 660 </ListItem></VarListEntry>
 661 </VariableList>
 662 </Para>
 663
 664 </Sect2>
 665
 666 <Sect2 id="pre-supposed-other-tools">
 667 <Title>Other useful tools
 668 </Title>
 669
 670 <VariableList>
 671 <VarListEntry>
 672 <Term>Flex:</Term>
 673 <IndexTerm><Primary>pre-supposed: flex</Primary></IndexTerm>
 674 <IndexTerm><Primary>flex, pre-supposed</Primary></IndexTerm>
 675 <ListItem>
 676
 677 <Para>
 678 This is a quite-a-bit-better-than-Lex lexer.  Used to build a couple
 679 of utilities in <Literal>glafp-utils</Literal>.  Depending on your
 680 operating system, the supplied <Command>lex</Command> may or may not
 681 work; you should get the GNU version.
 682 </Para>
 683 </ListItem></VarListEntry>
 684 </VariableList>
 685
 686 </Sect2>
 687
 688 </Sect1>
 689
 690 <Sect1 id="sec-building-from-source">
 691 <Title>Building from source
 692
 693 <IndexTerm><Primary>Building from source</Primary></IndexTerm>
 694 <IndexTerm><Primary>Source, building from</Primary></IndexTerm></Title>
 695
 696 <Para>
 697 You've been rash enough to want to build some of
 698 the Glasgow Functional Programming tools (GHC, Happy,
 699 nofib, etc.) from source.  You've slurped the source,
 700 from the CVS repository or from a source distribution, and
 701 now you're sitting looking at a huge mound of bits, wondering
 702 what to do next.
 703 </Para>
 704
 705 <Para>
 706 Gingerly, you type <Command>make</Command>.  Wrong already!
 707 </Para>
 708
 709 <Para>
 710 This rest of this guide is intended for duffers like me, who aren't
 711 really interested in Makefiles and systems configurations, but who
 712 need a mental model of the interlocking pieces so that they can make
 713 them work, extend them consistently when adding new software, and lay
 714 hands on them gently when they don't work.
 715 </Para>
 716
 717 <Sect2 id="sec-source-tree">
 718 <Title>Your source tree
 719 </Title>
 720
 721 <Para>
 722 The source code is held in your <Emphasis>source tree</Emphasis>.
 723 The root directory of your source tree <Emphasis>must</Emphasis>
 724 contain the following directories and files:
 725 </Para>
 726
 727 <Para>
 728
 729 <ItemizedList>
 730 <ListItem>
 731
 732 <Para>
 733 <Filename>Makefile</Filename>: the root Makefile.
 734 </Para>
 735 </ListItem>
 736 <ListItem>
 737
 738 <Para>
 739 <Filename>mk/</Filename>: the directory that contains the
 740 main Makefile code, shared by all the
 741 <Literal>fptools</Literal> software.
 742 </Para>
 743 </ListItem>
 744 <ListItem>
 745
 746 <Para>
 747  <Filename>configure.in</Filename>, <Filename>config.sub</Filename>, <Filename>config.guess</Filename>:
 748 these files support the configuration process.
 749 </Para>
 750 </ListItem>
 751 <ListItem>
 752
 753 <Para>
 754  <Filename>install-sh</Filename>.
 755 </Para>
 756 </ListItem>
 757
 758 </ItemizedList>
 759
 760 </Para>
 761
 762 <Para>
 763 All the other directories are individual <Emphasis>projects</Emphasis> of the
 764 <Literal>fptools</Literal> system&mdash;for example, the Glasgow Haskell Compiler
 765 (<Literal>ghc</Literal>), the Happy parser generator (<Literal>happy</Literal>), the <Literal>nofib</Literal> benchmark
 766 suite, and so on.  You can have zero or more of these.  Needless to
 767 say, some of them are needed to build others.
 768 </Para>
 769
 770 <Para>
 771 The important thing to remember is that even if you want only one
 772 project (<Literal>happy</Literal>, say), you must have a source tree whose root
 773 directory contains <Filename>Makefile</Filename>, <Filename>mk/</Filename>, <Filename>configure.in</Filename>, and the
 774 project(s) you want (<Filename>happy/</Filename> in this case).  You cannot get by with
 775 just the <Filename>happy/</Filename> directory.
 776 </Para>
 777
 778 </Sect2>
 779
 780 <Sect2>
 781 <Title>Build trees
 782 <IndexTerm><Primary>build trees</Primary></IndexTerm>
 783 <IndexTerm><Primary>link trees, for building</Primary></IndexTerm></Title>
 784
 785 <Para>
 786 While you can build a system in the source tree, we don't recommend it.
 787 We often want to build multiple versions of our software
 788 for different architectures, or with different options (e.g. profiling).
 789 It's very desirable to share a single copy of the source code among
 790 all these builds.
 791 </Para>
 792
 793 <Para>
 794 So for every source tree we have zero or more <Emphasis>build trees</Emphasis>.  Each
 795 build tree is initially an exact copy of the source tree, except that
 796 each file is a symbolic link to the source file, rather than being a
 797 copy of the source file.  There are ``standard'' Unix utilities that
 798 make such copies, so standard that they go by different names:
 799 <Command>lndir</Command><IndexTerm><Primary>lndir</Primary></IndexTerm>, <Command>mkshadowdir</Command><IndexTerm><Primary>mkshadowdir</Primary></IndexTerm> are two (If you
 800 don't have either, the source distribution includes sources for the
 801 X11 <Command>lndir</Command>&mdash;check out <Filename>fptools/glafp-utils/lndir</Filename>). See <Xref LinkEnd="sec-storysofar"> for a typical invocation.
 802 </Para>
 803
 804 <Para>
 805 The build tree does not need to be anywhere near the source tree in
 806 the file system.  Indeed, one advantage of separating the build tree
 807 from the source is that the build tree can be placed in a
 808 non-backed-up partition, saving your systems support people from
 809 backing up untold megabytes of easily-regenerated, and
 810 rapidly-changing, gubbins.  The golden rule is that (with a single
 811 exception&mdash;<XRef LinkEnd="sec-build-config">)
 812 <Emphasis>absolutely everything in the build tree is either a symbolic
 813 link to the source tree, or else is mechanically generated</Emphasis>.
 814 It should be perfectly OK for your build tree to vanish overnight; an
 815 hour or two compiling and you're on the road again.
 816 </Para>
 817
 818 <Para>
 819 You need to be a bit careful, though, that any new files you create
 820 (if you do any development work) are in the source tree, not a build tree!
 821 </Para>
 822
 823 <Para>
 824 Remember, that the source files in the build tree are <Emphasis>symbolic
 825 links</Emphasis> to the files in the source tree.  (The build tree soon
 826 accumulates lots of built files like <Filename>Foo.o</Filename>, as well.)  You
 827 can <Emphasis>delete</Emphasis> a source file from the build tree without affecting
 828 the source tree (though it's an odd thing to do).  On the other hand,
 829 if you <Emphasis>edit</Emphasis> a source file from the build tree, you'll edit the
 830 source-tree file directly.  (You can set up Emacs so that if you edit
 831 a source file from the build tree, Emacs will silently create an
 832 edited copy of the source file in the build tree, leaving the source
 833 file unchanged; but the danger is that you think you've edited the
 834 source file whereas actually all you've done is edit the build-tree
 835 copy.  More commonly you do want to edit the source file.)
 836 </Para>
 837
 838 <Para>
 839 Like the source tree, the top level of your build tree must be (a
 840 linked copy of) the root directory of the <Literal>fptools</Literal> suite.  Inside
 841 Makefiles, the root of your build tree is called
 842 <Constant>&dollar;(FPTOOLS&lowbar;TOP)</Constant><IndexTerm><Primary>FPTOOLS&lowbar;TOP</Primary></IndexTerm>.  In the rest of this document path
 843 names are relative to <Constant>&dollar;(FPTOOLS&lowbar;TOP)</Constant> unless otherwise stated.  For
 844 example, the file <Filename>ghc/mk/target.mk</Filename> is actually
 845 <Filename><Constant>&dollar;(FPTOOLS&lowbar;TOP)</Constant>/ghc/mk/target.mk</Filename>.
 846 </Para>
 847
 848 </Sect2>
 849
 850 <Sect2 id="sec-build-config">
 851 <Title>Getting the build you want
 852 </Title>
 853
 854 <Para>
 855 When you build <Literal>fptools</Literal> you will be compiling code on a particular
 856 <Emphasis>host platform</Emphasis>, to run on a particular <Emphasis>target platform</Emphasis>
 857 (usually the same as the host platform)<IndexTerm><Primary>platform</Primary></IndexTerm>.  The
 858 difficulty is that there are minor differences between different
 859 platforms; minor, but enough that the code needs to be a bit different
 860 for each.  There are some big differences too: for a different
 861 architecture we need to build GHC with a different native-code
 862 generator.
 863 </Para>
 864
 865 <Para>
 866 There are also knobs you can turn to control how the <Literal>fptools</Literal>
 867 software is built.  For example, you might want to build GHC optimised
 868 (so that it runs fast) or unoptimised (so that you can compile it fast
 869 after you've modified it.  Or, you might want to compile it with
 870 debugging on (so that extra consistency-checking code gets included)
 871 or off.  And so on.
 872 </Para>
 873
 874 <Para>
 875 All of this stuff is called the <Emphasis>configuration</Emphasis> of your build.
 876 You set the configuration using a three-step process.
 877 <VariableList>
 878
 879 <VarListEntry>
 880 <Term>Step 1: get ready for configuration.</Term>
 881 <ListItem>
 882 <Para>
 883 Change directory to
 884 <Constant>&dollar;(FPTOOLS&lowbar;TOP)</Constant> and issue the command <Command>autoconf</Command><IndexTerm><Primary>autoconf</Primary></IndexTerm> (with
 885 no arguments). This GNU program converts <Filename><Constant>&dollar;(FPTOOLS&lowbar;TOP)</Constant>/configure.in</Filename>
 886 to a shell script called <Filename><Constant>&dollar;(FPTOOLS&lowbar;TOP)</Constant>/configure</Filename>.
 887 </Para>
 888
 889 <para>
 890 Some projects, including GHC, have their own configure script.  If
 891 there's an
 892 <Constant>&dollar;(FPTOOLS&lowbar;TOP)/&lt;project&gt;/configure.in</Constant>,
 893 then you need to run <command>autoconf</command> in that directory too.
 894 </para>
 895
 896 <Para>
 897 Both these steps are completely platform-independent; they just mean
 898 that the human-written file (<Filename>configure.in</Filename>) can be short, although
 899 the resulting shell script, <Command>configure</Command>, and <Filename>mk/config.h.in</Filename>, are
 900 long.
 901 </Para>
 902
 903 <Para>
 904 In case you don't have <Command>autoconf</Command> we distribute the results,
 905 <Command>configure</Command>, and <Filename>mk/config.h.in</Filename>, with the source distribution.  They
 906 aren't kept in the repository, though.
 907 </Para>
 908 </ListItem></VarListEntry>
 909 <VarListEntry>
 910 <Term>Step 2: system configuration.</Term>
 911 <ListItem>
 912 <Para>
 913 Runs the newly-created <Command>configure</Command> script, thus:
 914
 915 <ProgramListing>
 916 ./configure
 917 </ProgramListing>
 918
 919 <Command>configure</Command>'s mission is to scurry round your
 920 computer working out what architecture it has, what operating system,
 921 whether it has the <Function>vfork</Function> system call, where
 922 <Command>yacc</Command> is kept, whether <Command>gcc</Command> is
 923 available, where various obscure <Literal>&num;include</Literal> files
 924 are, whether it's a leap year, and what the systems manager had for
 925 lunch.  It communicates these snippets of information in two ways:
 926 </Para>
 927
 928 <Para>
 929
 930 <ItemizedList>
 931 <ListItem>
 932
 933 <Para>
 934  It translates <Filename>mk/config.mk.in</Filename><IndexTerm><Primary>config.mk.in</Primary></IndexTerm> to
 935 <Filename>mk/config.mk</Filename><IndexTerm><Primary>config.mk</Primary></IndexTerm>, substituting for things between
 936 ``<Literal>@</Literal>'' brackets.  So, ``<Literal>@HaveGcc@</Literal>'' will be replaced by
 937 ``<Literal>YES</Literal>'' or ``<Literal>NO</Literal>'' depending on what <Command>configure</Command> finds.
 938 <Filename>mk/config.mk</Filename> is included by every Makefile (directly or indirectly),
 939 so the configuration information is thereby communicated to all
 940 Makefiles.
 941
 942 </Para>
 943 </ListItem>
 944 <ListItem>
 945
 946 <Para>
 947  It translates <Filename>mk/config.h.in</Filename><IndexTerm><Primary>config.h.in</Primary></IndexTerm> to
 948 <Filename>mk/config.h</Filename><IndexTerm><Primary>config.h</Primary></IndexTerm>.  The latter is <Literal>&num;include</Literal>d by various C
 949 programs, which can thereby make use of configuration information.
 950
 951 </Para>
 952 </ListItem>
 953
 954 </ItemizedList>
 955
 956 </Para>
 957
 958 <Para>
 959 <Command>configure</Command> caches the results of its run in <Filename>config.cache</Filename>.  Quite
 960 often you don't want that; you're running <Command>configure</Command> a second time
 961 because something has changed.  In that case, simply delete
 962 <Filename>config.cache</Filename>.
 963 </Para>
 964 </ListItem></VarListEntry>
 965 <VarListEntry>
 966 <Term>Step 3: build configuration.</Term>
 967 <ListItem>
 968 <Para>
 969 Next, you say how this build of <Literal>fptools</Literal> is to differ from the
 970 standard defaults by creating a new file <Filename>mk/build.mk</Filename><IndexTerm><Primary>build.mk</Primary></IndexTerm>
 971 <Emphasis>in the build tree</Emphasis>.  This file is the one and only file you edit
 972 in the build tree, precisely because it says how this build differs
 973 from the source.  (Just in case your build tree does die, you might
 974 want to keep a private directory of <Filename>build.mk</Filename> files, and use a
 975 symbolic link in each build tree to point to the appropriate one.)  So
 976 <Filename>mk/build.mk</Filename> never exists in the source tree&mdash;you create one in
 977 each build tree from the template.  We'll discuss what to put in it
 978 shortly.
 979 </Para>
 980 </ListItem></VarListEntry>
 981 </VariableList>
 982 </Para>
 983
 984 <Para>
 985 And that's it for configuration. Simple, eh?
 986 </Para>
 987
 988 <Para>
 989 What do you put in your build-specific configuration file
 990 <Filename>mk/build.mk</Filename>?  <Emphasis>For almost all purposes all you will do is put
 991 make variable definitions that override those in</Emphasis> <Filename>mk/config.mk.in</Filename>.
 992 The whole point of <Filename>mk/config.mk.in</Filename>&mdash;and its derived counterpart
 993 <Filename>mk/config.mk</Filename>&mdash;is to define the build configuration. It is heavily
 994 commented, as you will see if you look at it.  So generally, what you
 995 do is look at <Filename>mk/config.mk.in</Filename>, and add definitions in <Filename>mk/build.mk</Filename>
 996 that override any of the <Filename>config.mk</Filename> definitions that you want to
 997 change.  (The override occurs because the main boilerplate file,
 998 <Filename>mk/boilerplate.mk</Filename><IndexTerm><Primary>boilerplate.mk</Primary></IndexTerm>, includes <Filename>build.mk</Filename> after
 999 <Filename>config.mk</Filename>.)
1000 </Para>
1001
1002 <Para>
1003 For example, <Filename>config.mk.in</Filename> contains the definition:
1004 </Para>
1005
1006 <Para>
1007
1008 <ProgramListing>
1009 ProjectsToBuild = glafp-utils ghc hslibs
1010 </ProgramListing>
1011
1012 </Para>
1013
1014 <Para>
1015 The accompanying comment explains that this is the list of enabled
1016 projects; that is, if (after configuring) you type <Command>gmake all</Command> in
1017 <Constant>FPTOOLS&lowbar;TOP</Constant> three specified projects will be made.  If you want to
1018 add <Command>green-card</Command>, you can add this line to <Filename>build.mk</Filename>:
1019 </Para>
1020
1021 <Para>
1022
1023 <ProgramListing>
1024 ProjectsToBuild += green-card
1025 </ProgramListing>
1026
1027 </Para>
1028
1029 <Para>
1030 or, if you prefer,
1031 </Para>
1032
1033 <Para>
1034
1035 <ProgramListing>
1036 ProjectsToBuild = glafp-utils ghc green-card
1037 </ProgramListing>
1038
1039 </Para>
1040
1041 <Para>
1042 (GNU <Command>make</Command> allows existing definitions to have new text appended
1043 using the ``<Literal>+=</Literal>'' operator, which is quite a convenient feature.)
1044 </Para>
1045
1046 <Para>
1047 When reading <Filename>config.mk.in</Filename>, remember that anything between
1048 ``@...@'' signs is going to be substituted by <Command>configure</Command>
1049 later.  You <Emphasis>can</Emphasis> override the resulting definition if you want,
1050 but you need to be a bit surer what you are doing.  For example,
1051 there's a line that says:
1052 </Para>
1053
1054 <Para>
1055
1056 <ProgramListing>
1057 YACC = @YaccCmd@
1058 </ProgramListing>
1059
1060 </Para>
1061
1062 <Para>
1063 This defines the Make variables <Constant>YACC</Constant> to the pathname for a <Command>yacc</Command> that
1064 <Command>configure</Command> finds somewhere.  If you have your own pet <Command>yacc</Command> you want
1065 to use instead, that's fine. Just add this line to <Filename>mk/build.mk</Filename>:
1066 </Para>
1067
1068 <Para>
1069
1070 <ProgramListing>
1071 YACC = myyacc
1072 </ProgramListing>
1073
1074 </Para>
1075
1076 <Para>
1077 You do not <Emphasis>have</Emphasis> to have a <Filename>mk/build.mk</Filename> file at all; if you
1078 don't, you'll get all the default settings from <Filename>mk/config.mk.in</Filename>.
1079 </Para>
1080
1081 <Para>
1082 You can also use <Filename>build.mk</Filename> to override anything that <Command>configure</Command> got
1083 wrong.  One place where this happens often is with the definition of
1084 <Constant>FPTOOLS&lowbar;TOP&lowbar;ABS</Constant>: this variable is supposed to be the canonical path
1085 to the top of your source tree, but if your system uses an automounter
1086 then the correct directory is hard to find automatically.  If you find
1087 that <Command>configure</Command> has got it wrong, just put the correct definition in
1088 <Filename>build.mk</Filename>.
1089 </Para>
1090
1091 </Sect2>
1092
1093 <Sect2 id="sec-storysofar">
1094 <Title>The story so far</Title>
1095
1096 <Para>
1097 Let's summarise the steps you need to carry to get yourself
1098 a fully-configured build tree from scratch.
1099 </Para>
1100
1101 <Para>
1102
1103 <OrderedList>
1104 <ListItem>
1105
1106 <Para>
1107  Get your source tree from somewhere (CVS repository or source
1108 distribution).  Say you call the root directory <Filename>myfptools</Filename> (it
1109 does not have to be called <Filename>fptools</Filename>).  Make sure that you have
1110 the essential files (see <XRef LinkEnd="sec-source-tree">).
1111
1112 </Para>
1113 </ListItem>
1114 <ListItem>
1115
1116 <Para>
1117  Use <Command>lndir</Command> or <Command>mkshadowdir</Command> to create a build tree.
1118
1119 <ProgramListing>
1120 cd myfptools
1121 mkshadowdir . /scratch/joe-bloggs/myfptools-sun4
1122 </ProgramListing>
1123
1124 (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
1125 suggests its main defining characteristic (in your mind at least),
1126 in case you later add others.
1127
1128 </Para>
1129 </ListItem>
1130 <ListItem>
1131
1132 <Para>
1133  Change directory to the build tree.  Everything is going
1134 to happen there now.
1135
1136 <ProgramListing>
1137 cd /scratch/joe-bloggs/myfptools-sun4
1138 </ProgramListing>
1139
1140 </Para>
1141 </ListItem>
1142 <ListItem>
1143
1144 <Para>
1145  Prepare for system configuration:
1146
1147 <ProgramListing>
1148 autoconf
1149 </ProgramListing>
1150
1151 (You can skip this step if you are starting from a source distribution,
1152 and you already have <Filename>configure</Filename> and <Filename>mk/config.h.in</Filename>.)
1153
1154 </Para>
1155 </ListItem>
1156 <ListItem>
1157
1158 <Para>
1159  Do system configuration:
1160
1161 <ProgramListing>
1162 ./configure
1163 </ProgramListing>
1164
1165
1166 </Para>
1167 </ListItem>
1168 <ListItem>
1169
1170 <Para>
1171  Create the file <Filename>mk/build.mk</Filename>,
1172 adding definitions for your desired configuration options.
1173
1174 <ProgramListing>
1175 emacs mk/build.mk
1176 </ProgramListing>
1177
1178 </Para>
1179 </ListItem>
1180
1181 </OrderedList>
1182
1183 You can make subsequent changes to <Filename>mk/build.mk</Filename> as often
1184 as you like.  You do not have to run any further configuration
1185 programs to make these changes take effect.
1186 In theory you should, however, say <Command>gmake clean</Command>, <Command>gmake all</Command>,
1187 because configuration option changes could affect anything&mdash;but in practice you are likely to know what's affected.
1188 </Para>
1189
1190 </Sect2>
1191
1192 <Sect2>
1193 <Title>Making things</Title>
1194
1195 <Para>
1196 At this point you have made yourself a fully-configured build tree,
1197 so you are ready to start building real things.
1198 </Para>
1199
1200 <Para>
1201 The first thing you need to know is that
1202 <Emphasis>you must use GNU <Command>make</Command>, usually called <Command>gmake</Command>, not standard Unix <Command>make</Command></Emphasis>.
1203 If you use standard Unix <Command>make</Command> you will get all sorts of error messages
1204 (but no damage) because the <Literal>fptools</Literal> <Command>Makefiles</Command> use GNU <Command>make</Command>'s facilities
1205 extensively.
1206 </Para>
1207
1208 </Sect2>
1209
1210 <Sect2 id="sec-standard-targets">
1211 <Title>Standard Targets
1212
1213 <IndexTerm><Primary>targets, standard makefile</Primary></IndexTerm>
1214 <IndexTerm><Primary>makefile targets</Primary></IndexTerm></Title>
1215
1216 <Para>
1217 In any directory you should be able to make the following:
1218 <VariableList>
1219
1220 <VarListEntry>
1221 <Term><Literal>boot</Literal>:</Term>
1222 <ListItem>
1223 <Para>
1224 does the one-off preparation required to get ready for the real work.
1225 Notably, it does <Command>gmake depend</Command> in all directories that contain
1226 programs.  It also builds the necessary tools for compilation to proceed.
1227 </Para>
1228
1229 <Para>
1230 You should say <Command>gmake boot</Command> right after configuring your build tree,
1231 but note that this is a one-off, i.e., there's no need to re-do
1232 <Command>gmake boot</Command> if you should re-configure your build tree at a later
1233 stage (no harm caused if you do though).
1234 </Para>
1235 </ListItem></VarListEntry>
1236 <VarListEntry>
1237 <Term><Literal>all</Literal>:</Term>
1238 <ListItem>
1239 <Para>
1240 makes all the final target(s) for this Makefile.
1241 Depending on which directory you are in a ``final target'' may be an
1242 executable program, a library archive, a shell script, or a Postscript
1243 file.  Typing <Command>gmake</Command> alone is generally the same as typing <Command>gmake all</Command>.
1244 </Para>
1245 </ListItem></VarListEntry>
1246 <VarListEntry>
1247 <Term><Literal>install</Literal>:</Term>
1248 <ListItem>
1249 <Para>
1250 installs the things built by <Literal>all</Literal>.  Where does it
1251 install them?  That is specified by
1252 <Filename>mk/config.mk.in</Filename>; you can override it in
1253 <Filename>mk/build.mk</Filename>, or by running
1254 <command>configure</command> with command-line arguments like
1255 <literal>--bindir=/home/simonpj/bin</literal>;  see <literal>./configure
1256 --help</literal> for the full details.
1257 </Para>
1258 </ListItem></VarListEntry>
1259 <VarListEntry>
1260 <Term><Literal>uninstall</Literal>:</Term>
1261 <ListItem>
1262 <Para>
1263 reverses the effect of <Literal>install</Literal>.
1264 </Para>
1265 </ListItem></VarListEntry>
1266
1267 <VarListEntry>
1268 <Term><Literal>clean</Literal>:</Term>
1269 <ListItem>
1270 <Para>
1271 Delete all files from the current directory that are normally
1272 created by building the program.  Don't delete the files that
1273 record the configuration. Also preserve files that could be made
1274 by building, but normally aren't because the distribution comes
1275 with them.</para>
1276 </ListItem></VarListEntry>
1277
1278 <varlistentry>
1279 <term><literal>distclean</literal>:</term>
1280 <listitem>
1281 <para>Delete all files from the current directory that are created by
1282 configuring or building the program. If you have unpacked the source
1283 and built the program without creating any other files, <literal>make
1284 distclean</literal> should leave only the files that were in the
1285 distribution.</para>
1286 </listitem>
1287 </varlistentry>
1288
1289 <varlistentry>
1290 <term><literal>mostlyclean</literal>:</term>
1291 <listitem>
1292 <para>Like <literal>clean</literal>, but may refrain from deleting a
1293 few files that people normally don't want to recompile.</para>
1294 </listitem>
1295 </varlistentry>
1296
1297 <VarListEntry>
1298 <Term><Literal>maintainer-clean</Literal>:</Term>
1299 <ListItem>
1300 <Para>
1301 Delete everything from the current directory that can be reconstructed
1302 with this Makefile.  This typically includes everything deleted by
1303 <literal>distclean</literal>, plus more: C source files produced by
1304 Bison, tags tables, Info files, and so on.</para>
1305
1306 <para>One exception, however: <literal>make maintainer-clean</literal>
1307 should not delete <filename>configure</filename> even if
1308 <filename>configure</filename> can be remade using a rule in the
1309 <filename>Makefile</filename>. More generally, <literal>make
1310 maintainer-clean</literal> should not delete anything that needs to
1311 exist in order to run <filename>configure</filename> and then begin to
1312 build the program.</para>
1313 </listitem>
1314 </varlistentry>
1315
1316 <VarListEntry>
1317 <Term><Literal>check</Literal>:</Term>
1318 <ListItem>
1319 <Para>
1320 run the test suite.
1321 </Para>
1322 </ListItem></VarListEntry>
1323 </VariableList>
1324 </Para>
1325
1326 <Para>
1327 All of these standard targets automatically recurse into
1328 sub-directories.  Certain other standard targets do not:
1329 </Para>
1330
1331 <Para>
1332 <VariableList>
1333
1334 <VarListEntry>
1335 <Term><Literal>configure</Literal>:</Term>
1336 <ListItem>
1337 <Para>
1338 is only available in the root directory
1339 <Constant>&dollar;(FPTOOLS&lowbar;TOP)</Constant>; it has been discussed in <XRef LinkEnd="sec-build-config">.
1340 </Para>
1341 </ListItem></VarListEntry>
1342 <VarListEntry>
1343 <Term><Literal>depend</Literal>:</Term>
1344 <ListItem>
1345 <Para>
1346 make a <Filename>.depend</Filename> file in each directory that needs
1347 it. This <Filename>.depend</Filename> file contains mechanically-generated dependency
1348 information; for example, suppose a directory contains a Haskell
1349 source module <Filename>Foo.lhs</Filename> which imports another module <Literal>Baz</Literal>.
1350 Then the generated <Filename>.depend</Filename> file will contain the dependency:
1351 </Para>
1352
1353 <Para>
1354
1355 <ProgramListing>
1356 Foo.o : Baz.hi
1357 </ProgramListing>
1358
1359 </Para>
1360
1361 <Para>
1362 which says that the object file <Filename>Foo.o</Filename> depends on the interface file
1363 <Filename>Baz.hi</Filename> generated by compiling module <Literal>Baz</Literal>.  The <Filename>.depend</Filename> file is
1364 automatically included by every Makefile.
1365 </Para>
1366 </ListItem></VarListEntry>
1367 <VarListEntry>
1368 <Term><Literal>binary-dist</Literal>:</Term>
1369 <ListItem>
1370 <Para>
1371 make a binary distribution.  This is the
1372 target we use to build the binary distributions of GHC and Happy.
1373 </Para>
1374 </ListItem></VarListEntry>
1375 <VarListEntry>
1376 <Term><Literal>dist</Literal>:</Term>
1377 <ListItem>
1378 <Para>
1379 make a source distribution.  You must be in a
1380 linked build tree to make this target.
1381 </Para>
1382 </ListItem></VarListEntry>
1383 </VariableList>
1384 </Para>
1385
1386 <Para>
1387 Most <Filename>Makefile</Filename>s have targets other than these.  You can discover them by looking in the <Filename>Makefile</Filename> itself.
1388 </Para>
1389
1390 </Sect2>
1391
1392 <sect2>
1393 <title>Using a project from the build tree</title>
1394 <para>
1395 If you want to build GHC (say) and just use it direct from the build
1396 tree without doing <literal>make install</literal> first, you can run
1397 the in-place driver script:
1398 <filename>ghc/driver/ghc-inplace</filename>.
1399 </para>
1400
1401 <para> Do <emphasis>NOT</emphasis> use
1402 <filename>ghc/driver/ghc</filename>, or
1403 <filename>ghc/driver/ghc-4.xx</filename>, as these are the scripts
1404 intended for installation, and contain hard-wired paths to the
1405 installed libraries, rather than the libraries in the build tree.
1406 </para>
1407
1408 <para>
1409 Happy can similarly be run from the build tree, using
1410 <filename>happy/src/happy-inplace</filename>.
1411 </para>
1412 </sect2>
1413
1414 <Sect2>
1415 <Title>Fast Making <IndexTerm><Primary>fastmake</Primary></IndexTerm>
1416 <IndexTerm><Primary>dependencies, omitting</Primary></IndexTerm>
1417 <IndexTerm><Primary>FAST, makefile
1418 variable</Primary></IndexTerm></Title>
1419
1420 <Para>
1421 Sometimes the dependencies get in the way: if you've made a small
1422 change to one file, and you're absolutely sure that it won't affect
1423 anything else, but you know that <Command>make</Command> is going to rebuild everything
1424 anyway, the following hack may be useful:
1425 </Para>
1426
1427 <Para>
1428
1429 <ProgramListing>
1430 gmake FAST=YES
1431 </ProgramListing>
1432
1433 </Para>
1434
1435 <Para>
1436 This tells the make system to ignore dependencies and just build what
1437 you tell it to.  In other words, it's equivalent to temporarily
1438 removing the <Filename>.depend</Filename> file in the current directory (where
1439 <Command>mkdependHS</Command> and friends store their dependency information).
1440 </Para>
1441
1442 <Para>
1443 A bit of history: GHC used to come with a <Command>fastmake</Command> script that did
1444 the above job, but GNU make provides the features we need to do it
1445 without resorting to a script.  Also, we've found that fastmaking is
1446 less useful since the advent of GHC's recompilation checker (see the
1447 User's Guide section on "Separate Compilation").
1448 </Para>
1449
1450 </Sect2>
1451
1452 </Sect1>
1453
1454 <Sect1 id="sec-makefile-arch">
1455 <Title>The <Filename>Makefile</Filename> architecture
1456 <IndexTerm><Primary>makefile architecture</Primary></IndexTerm></Title>
1457
1458 <Para>
1459 <Command>make</Command> is great if everything works&mdash;you type <Command>gmake install</Command> and
1460 lo! the right things get compiled and installed in the right places.
1461 Our goal is to make this happen often, but somehow it often doesn't;
1462 instead some weird error message eventually emerges from the bowels of
1463 a directory you didn't know existed.
1464 </Para>
1465
1466 <Para>
1467 The purpose of this section is to give you a road-map to help you figure
1468 out what is going right and what is going wrong.
1469 </Para>
1470
1471 <Sect2>
1472 <Title>A small project</Title>
1473
1474 <Para>
1475 To get started, let us look at the <Filename>Makefile</Filename> for an imaginary small
1476 <Literal>fptools</Literal> project, <Literal>small</Literal>.  Each project in <Literal>fptools</Literal> has its own
1477 directory in <Constant>FPTOOLS&lowbar;TOP</Constant>, so the <Literal>small</Literal> project will have its own
1478 directory <Constant>FPOOLS&lowbar;TOP/small/</Constant>.  Inside the <Filename>small/</Filename> directory there
1479 will be a <Filename>Makefile</Filename>, looking something like this:
1480 </Para>
1481
1482 <Para>
1483 <IndexTerm><Primary>Makefile, minimal</Primary></IndexTerm>
1484
1485 <ProgramListing>
1486 #     Makefile for fptools project "small"
1487
1488 TOP = ..
1489 include $(TOP)/mk/boilerplate.mk
1490
1491 SRCS = $(wildcard *.lhs) $(wildcard *.c)
1492 HS_PROG = small
1493
1494 include $(TOP)/target.mk
1495 </ProgramListing>
1496
1497 </Para>
1498
1499 <Para>
1500 This <Filename>Makefile</Filename> has three sections:
1501 </Para>
1502
1503 <Para>
1504
1505 <OrderedList>
1506 <ListItem>
1507
1508 <Para>
1509  The first section includes
1510 <FOOTNOTE>
1511
1512 <Para>
1513 One of the most important
1514 features of GNU <Command>make</Command> that we use is the ability for a <Filename>Makefile</Filename> to
1515 include another named file, very like <Command>cpp</Command>'s <Literal>&num;include</Literal>
1516 directive.
1517 </Para>
1518
1519 </FOOTNOTE>
1520  a file of ``boilerplate'' code from the level
1521 above (which in this case will be
1522 <Filename><Constant>FPTOOLS&lowbar;TOP</Constant>/mk/boilerplate.mk</Filename><IndexTerm><Primary>boilerplate.mk</Primary></IndexTerm>).  As its name
1523 suggests, <Filename>boilerplate.mk</Filename> consists of a large quantity of standard
1524 <Filename>Makefile</Filename> code.  We discuss this boilerplate in more detail in
1525 <XRef LinkEnd="sec-boiler">.
1526 <IndexTerm><Primary>include, directive in Makefiles</Primary></IndexTerm>
1527 <IndexTerm><Primary>Makefile inclusion</Primary></IndexTerm>
1528
1529 Before the <Literal>include</Literal> statement, you must define the <Command>make</Command> variable
1530 <Constant>TOP</Constant><IndexTerm><Primary>TOP</Primary></IndexTerm> to be the directory containing the <Filename>mk</Filename> directory in
1531 which the <Filename>boilerplate.mk</Filename> file is.  It is <Emphasis>not</Emphasis> OK to simply say
1532
1533
1534 <ProgramListing>
1535 include ../mk/boilerplate.mk  # NO NO NO
1536 </ProgramListing>
1537
1538
1539 Why?  Because the <Filename>boilerplate.mk</Filename> file needs to know where it is, so
1540 that it can, in turn, <Literal>include</Literal> other files.  (Unfortunately, when an
1541 <Literal>include</Literal>d file does an <Literal>include</Literal>, the filename is treated relative to
1542 the directory in which <Command>gmake</Command> is being run, not the directory in
1543 which the <Literal>include</Literal>d sits.)  In general, <Emphasis>every file <Filename>foo.mk</Filename>
1544 assumes that <Filename><Constant>&dollar;(TOP)</Constant>/mk/foo.mk</Filename> refers to itself.</Emphasis> It is up to the
1545 <Filename>Makefile</Filename> doing the <Literal>include</Literal> to ensure this is the case.
1546
1547 Files intended for inclusion in other <Filename>Makefile</Filename>s are written to have
1548 the following property: <Emphasis>after <Filename>foo.mk</Filename> is <Literal>include</Literal>d, it leaves
1549 <Constant>TOP</Constant> containing the same value as it had just before the <Literal>include</Literal>
1550 statement</Emphasis>.  In our example, this invariant guarantees that the
1551 <Literal>include</Literal> for <Filename>target.mk</Filename> will look in the same directory as that for
1552 <Filename>boilerplate.mk</Filename>.
1553
1554 </Para>
1555 </ListItem>
1556 <ListItem>
1557
1558 <Para>
1559  The second section defines the following standard <Command>make</Command>
1560 variables: <Constant>SRCS</Constant><IndexTerm><Primary>SRCS</Primary></IndexTerm> (the source files from which is to be
1561 built), and <Constant>HS&lowbar;PROG</Constant><IndexTerm><Primary>HS&lowbar;PROG</Primary></IndexTerm> (the executable binary to be
1562 built).  We will discuss in more detail what the ``standard
1563 variables'' are, and how they affect what happens, in <XRef LinkEnd="sec-targets">.
1564
1565 The definition for <Constant>SRCS</Constant> uses the useful GNU <Command>make</Command> construct
1566 <Literal>&dollar;(wildcard&nbsp;$pat$)</Literal><IndexTerm><Primary>wildcard</Primary></IndexTerm>, which expands to a list of all
1567 the files matching the pattern <Literal>pat</Literal> in the current directory.  In
1568 this example, <Constant>SRCS</Constant> is set to the list of all the <Filename>.lhs</Filename> and <Filename>.c</Filename>
1569 files in the directory.  (Let's suppose there is one of each,
1570 <Filename>Foo.lhs</Filename> and <Filename>Baz.c</Filename>.)
1571
1572 </Para>
1573 </ListItem>
1574 <ListItem>
1575
1576 <Para>
1577  The last section includes a second file of standard code,
1578 called <Filename>target.mk</Filename><IndexTerm><Primary>target.mk</Primary></IndexTerm>.  It contains the rules that tell
1579 <Command>gmake</Command> how to make the standard targets (<Xref LinkEnd="sec-standard-targets">).  Why, you ask,
1580 can't this standard code be part of <Filename>boilerplate.mk</Filename>?  Good question.
1581 We discuss the reason later, in <Xref LinkEnd="sec-boiler-arch">.
1582
1583 You do not <Emphasis>have</Emphasis> to <Literal>include</Literal> the <Filename>target.mk</Filename> file.  Instead, you
1584 can write rules of your own for all the standard targets.  Usually,
1585 though, you will find quite a big payoff from using the canned rules
1586 in <Filename>target.mk</Filename>; the price tag is that you have to understand what
1587 canned rules get enabled, and what they do (<Xref LinkEnd="sec-targets">).
1588
1589 </Para>
1590 </ListItem>
1591
1592 </OrderedList>
1593
1594 </Para>
1595
1596 <Para>
1597 In our example <Filename>Makefile</Filename>, most of the work is done by the two
1598 <Literal>include</Literal>d files.  When you say <Command>gmake all</Command>, the following things
1599 happen:
1600 </Para>
1601
1602 <Para>
1603
1604 <ItemizedList>
1605 <ListItem>
1606
1607 <Para>
1608  <Command>gmake</Command> figures out that the object files are <Filename>Foo.o</Filename> and
1609 <Filename>Baz.o</Filename>.
1610
1611 </Para>
1612 </ListItem>
1613 <ListItem>
1614
1615 <Para>
1616  It uses a boilerplate pattern rule to compile <Filename>Foo.lhs</Filename> to
1617 <Filename>Foo.o</Filename> using a Haskell compiler.  (Which one?  That is set in the
1618 build configuration.)
1619
1620 </Para>
1621 </ListItem>
1622 <ListItem>
1623
1624 <Para>
1625  It uses another standard pattern rule to compile <Filename>Baz.c</Filename> to
1626 <Filename>Baz.o</Filename>, using a C compiler.  (Ditto.)
1627
1628 </Para>
1629 </ListItem>
1630 <ListItem>
1631
1632 <Para>
1633  It links the resulting <Filename>.o</Filename> files together to make <Literal>small</Literal>,
1634 using the Haskell compiler to do the link step.  (Why not use <Command>ld</Command>?
1635 Because the Haskell compiler knows what standard libraries to link in.
1636 How did <Command>gmake</Command> know to use the Haskell compiler to do the link,
1637 rather than the C compiler?  Because we set the variable <Constant>HS&lowbar;PROG</Constant>
1638 rather than <Constant>C&lowbar;PROG</Constant>.)
1639
1640 </Para>
1641 </ListItem>
1642
1643 </ItemizedList>
1644
1645 </Para>
1646
1647 <Para>
1648 All <Filename>Makefile</Filename>s should follow the above three-section format.
1649 </Para>
1650
1651 </Sect2>
1652
1653 <Sect2>
1654 <Title>A larger project</Title>
1655
1656 <Para>
1657 Larger projects are usually structured into a number of sub-directories,
1658 each of which has its own <Filename>Makefile</Filename>.  (In very large projects, this
1659 sub-structure might be iterated recursively, though that is rare.)
1660 To give you the idea, here's part of the directory structure for
1661 the (rather large) GHC project:
1662 </Para>
1663
1664 <Para>
1665
1666 <Screen>
1667 $(FPTOOLS_TOP)/ghc/
1668   Makefile
1669   mk/
1670     boilerplate.mk
1671     rules.mk
1672    docs/
1673     Makefile
1674     ...source files for documentation...
1675    driver/
1676     Makefile
1677     ...source files for driver...
1678    compiler/
1679     Makefile
1680     parser/...source files for parser...
1681     renamer/...source files for renamer...
1682     ...etc...
1683 </Screen>
1684
1685 </Para>
1686
1687 <Para>
1688 The sub-directories <Filename>docs</Filename>, <Filename>driver</Filename>, <Filename>compiler</Filename>, and so on, each
1689 contains a sub-component of GHC, and each has its own <Filename>Makefile</Filename>.
1690 There must also be a <Filename>Makefile</Filename> in <Filename><Constant>&dollar;(FPTOOLS&lowbar;TOP)</Constant>/ghc</Filename>.  It does most
1691 of its work by recursively invoking <Command>gmake</Command> on the <Filename>Makefile</Filename>s in the
1692 sub-directories.  We say that <Filename>ghc/Makefile</Filename> is a <Emphasis>non-leaf
1693 <Filename>Makefile</Filename></Emphasis>, because it does little except organise its children,
1694 while the <Filename>Makefile</Filename>s in the sub-directories are all <Emphasis>leaf
1695 <Filename>Makefile</Filename>s</Emphasis>.  (In principle the sub-directories might themselves
1696 contain a non-leaf <Filename>Makefile</Filename> and several sub-sub-directories, but
1697 that does not happen in GHC.)
1698 </Para>
1699
1700 <Para>
1701 The <Filename>Makefile</Filename> in <Filename>ghc/compiler</Filename> is considered a leaf <Filename>Makefile</Filename> even
1702 though the <Filename>ghc/compiler</Filename> has sub-directories, because these sub-directories
1703 do not themselves have <Filename>Makefile</Filename>s in them.  They are just used to structure
1704 the collection of modules that make up GHC, but all are managed by the
1705 single <Filename>Makefile</Filename> in <Filename>ghc/compiler</Filename>.
1706 </Para>
1707
1708 <Para>
1709 You will notice that <Filename>ghc/</Filename> also contains a directory <Filename>ghc/mk/</Filename>.  It
1710 contains GHC-specific <Filename>Makefile</Filename> boilerplate code.  More precisely:
1711 </Para>
1712
1713 <Para>
1714
1715 <ItemizedList>
1716 <ListItem>
1717
1718 <Para>
1719  <Filename>ghc/mk/boilerplate.mk</Filename> is included at the top of
1720 <Filename>ghc/Makefile</Filename>, and of all the leaf <Filename>Makefile</Filename>s in the
1721 sub-directories.  It in turn <Literal>include</Literal>s the main boilerplate file
1722 <Filename>mk/boilerplate.mk</Filename>.
1723
1724
1725 </Para>
1726 </ListItem>
1727 <ListItem>
1728
1729 <Para>
1730  <Filename>ghc/mk/target.mk</Filename> is <Literal>include</Literal>d at the bottom of
1731 <Filename>ghc/Makefile</Filename>, and of all the leaf <Filename>Makefile</Filename>s in the
1732 sub-directories.  It in turn <Literal>include</Literal>s the file <Filename>mk/target.mk</Filename>.
1733
1734 </Para>
1735 </ListItem>
1736
1737 </ItemizedList>
1738
1739 </Para>
1740
1741 <Para>
1742 So these two files are the place to look for GHC-wide customisation
1743 of the standard boilerplate.
1744 </Para>
1745
1746 </Sect2>
1747
1748 <Sect2 id="sec-boiler-arch">
1749 <Title>Boilerplate architecture
1750 <IndexTerm><Primary>boilerplate architecture</Primary></IndexTerm>
1751 </Title>
1752
1753 <Para>
1754 Every <Filename>Makefile</Filename> includes a <Filename>boilerplate.mk</Filename><IndexTerm><Primary>boilerplate.mk</Primary></IndexTerm> file
1755 at the top, and <Filename>target.mk</Filename><IndexTerm><Primary>target.mk</Primary></IndexTerm> file at the bottom.  In
1756 this section we discuss what is in these files, and why there have to
1757 be two of them.  In general:
1758 </Para>
1759
1760 <Para>
1761
1762 <ItemizedList>
1763 <ListItem>
1764
1765 <Para>
1766  <Filename>boilerplate.mk</Filename> consists of:
1767
1768 <ItemizedList>
1769 <ListItem>
1770
1771 <Para>
1772  <Emphasis>Definitions of millions of <Command>make</Command> variables</Emphasis> that
1773 collectively specify the build configuration.  Examples:
1774 <Constant>HC&lowbar;OPTS</Constant><IndexTerm><Primary>HC&lowbar;OPTS</Primary></IndexTerm>, the options to feed to the Haskell compiler;
1775 <Constant>NoFibSubDirs</Constant><IndexTerm><Primary>NoFibSubDirs</Primary></IndexTerm>, the sub-directories to enable within the
1776 <Literal>nofib</Literal> project; <Constant>GhcWithHc</Constant><IndexTerm><Primary>GhcWithHc</Primary></IndexTerm>, the name of the Haskell
1777 compiler to use when compiling GHC in the <Literal>ghc</Literal> project.
1778 </Para>
1779 </ListItem>
1780 <ListItem>
1781
1782 <Para>
1783 <Emphasis>Standard pattern rules</Emphasis> that tell <Command>gmake</Command> how to construct one
1784 file from another.
1785 </Para>
1786 </ListItem>
1787
1788 </ItemizedList>
1789
1790
1791 <Filename>boilerplate.mk</Filename> needs to be <Literal>include</Literal>d at the <Emphasis>top</Emphasis>
1792 of each <Filename>Makefile</Filename>, so that the user can replace the
1793 boilerplate definitions or pattern rules by simply giving a new
1794 definition or pattern rule in the <Filename>Makefile</Filename>.  <Command>gmake</Command>
1795 simply takes the last definition as the definitive one.
1796
1797 Instead of <Emphasis>replacing</Emphasis> boilerplate definitions, it is also quite
1798 common to <Emphasis>augment</Emphasis> them. For example, a <Filename>Makefile</Filename> might say:
1799
1800
1801 <ProgramListing>
1802 SRC_HC_OPTS += -O
1803 </ProgramListing>
1804
1805
1806 thereby adding ``<Option>-O</Option>'' to the end of <Constant>SRC&lowbar;HC&lowbar;OPTS</Constant><IndexTerm><Primary>SRC&lowbar;HC&lowbar;OPTS</Primary></IndexTerm>.
1807
1808 </Para>
1809 </ListItem>
1810 <ListItem>
1811
1812 <Para>
1813  <Filename>target.mk</Filename> contains <Command>make</Command> rules for the standard
1814 targets described in <Xref LinkEnd="sec-standard-targets">.  These rules are selectively included,
1815 depending on the setting of certain <Command>make</Command> variables.  These
1816 variables are usually set in the middle section of the
1817 <Filename>Makefile</Filename> between the two <Literal>include</Literal>s.
1818
1819 <Filename>target.mk</Filename> must be included at the end (rather than being part of
1820 <Filename>boilerplate.mk</Filename>) for several tiresome reasons:
1821
1822
1823 <ItemizedList>
1824 <ListItem>
1825
1826 <Para>
1827  <Command>gmake</Command> commits target and dependency lists earlier than
1828 it should.  For example, <FIlename>target.mk</FIlename> has a rule that looks like
1829 this:
1830
1831
1832 <ProgramListing>
1833 $(HS_PROG) : $(OBJS)
1834       $(HC) $(LD_OPTS) $&#60; -o $@
1835 </ProgramListing>
1836
1837
1838 If this rule was in <Filename>boilerplate.mk</Filename> then <Constant>&dollar;(HS&lowbar;PROG)</Constant><IndexTerm><Primary>HS&lowbar;PROG</Primary></IndexTerm>
1839 and <Constant>&dollar;(OBJS)</Constant><IndexTerm><Primary>OBJS</Primary></IndexTerm> would not have their final values at the
1840 moment <Command>gmake</Command> encountered the rule.  Alas, <Command>gmake</Command> takes a snapshot
1841 of their current values, and wires that snapshot into the rule.  (In
1842 contrast, the commands executed when the rule ``fires'' are only
1843 substituted at the moment of firing.)  So, the rule must follow the
1844 definitions given in the <Filename>Makefile</Filename> itself.
1845
1846 </Para>
1847 </ListItem>
1848 <ListItem>
1849
1850 <Para>
1851  Unlike pattern rules, ordinary rules cannot be overriden or
1852 replaced by subsequent rules for the same target (at least, not without an
1853 error message).  Including ordinary rules in <Filename>boilerplate.mk</Filename> would
1854 prevent the user from writing rules for specific targets in specific cases.
1855
1856 </Para>
1857 </ListItem>
1858 <ListItem>
1859
1860 <Para>
1861  There are a couple of other reasons I've forgotten, but it doesn't
1862 matter too much.
1863 </Para>
1864 </ListItem>
1865
1866 </ItemizedList>
1867
1868 </Para>
1869 </ListItem>
1870
1871 </ItemizedList>
1872
1873 </Para>
1874
1875 </Sect2>
1876
1877 <Sect2 id="sec-boiler">
1878 <Title>The main <Filename>mk/boilerplate.mk</Filename> file
1879
1880 <IndexTerm><Primary>boilerplate.mk</Primary></IndexTerm></Title>
1881
1882 <Para>
1883 If you look at <Filename><Constant>&dollar;(FPTOOLS&lowbar;TOP)</Constant>/mk/boilerplate.mk</Filename> you will find
1884 that it consists of the following sections, each held in a separate
1885 file:
1886 </Para>
1887
1888 <Para>
1889 <VariableList>
1890
1891 <VarListEntry>
1892 <Term><Filename>config.mk</Filename><IndexTerm><Primary>config.mk</Primary></IndexTerm></Term>
1893 <ListItem>
1894 <Para>
1895 is the build configuration file we
1896 discussed at length in <Xref LinkEnd="sec-build-config">.
1897 </Para>
1898 </ListItem></VarListEntry>
1899 <VarListEntry>
1900 <Term><Filename>paths.mk</Filename><IndexTerm><Primary>paths.mk</Primary></IndexTerm></Term>
1901 <ListItem>
1902 <Para>
1903 defines <Command>make</Command> variables for
1904 pathnames and file lists.  In particular, it gives definitions for:
1905 </Para>
1906
1907 <Para>
1908 <VariableList>
1909
1910 <VarListEntry>
1911 <Term><Constant>SRCS</Constant><IndexTerm><Primary>SRCS</Primary></IndexTerm>:</Term>
1912 <ListItem>
1913 <Para>
1914 all source files in the current directory.
1915 </Para>
1916 </ListItem></VarListEntry>
1917 <VarListEntry>
1918 <Term><Constant>HS&lowbar;SRCS</Constant><IndexTerm><Primary>HS&lowbar;SRCS</Primary></IndexTerm>:</Term>
1919 <ListItem>
1920 <Para>
1921 all Haskell source files in the current directory.
1922 It is derived from <Constant>&dollar;(SRCS)</Constant>, so if you override <Constant>SRCS</Constant> with a new value
1923 <Constant>HS&lowbar;SRCS</Constant> will follow suit.
1924 </Para>
1925 </ListItem></VarListEntry>
1926 <VarListEntry>
1927 <Term><Constant>C&lowbar;SRCS</Constant><IndexTerm><Primary>C&lowbar;SRCS</Primary></IndexTerm>:</Term>
1928 <ListItem>
1929 <Para>
1930 similarly for C source files.
1931 </Para>
1932 </ListItem></VarListEntry>
1933 <VarListEntry>
1934 <Term><Constant>HS&lowbar;OBJS</Constant><IndexTerm><Primary>HS&lowbar;OBJS</Primary></IndexTerm>:</Term>
1935 <ListItem>
1936 <Para>
1937 the <Filename>.o</Filename> files derived from <Constant>&dollar;(HS&lowbar;SRCS)</Constant>.
1938 </Para>
1939 </ListItem></VarListEntry>
1940 <VarListEntry>
1941 <Term><Constant>C&lowbar;OBJS</Constant><IndexTerm><Primary>C&lowbar;OBJS</Primary></IndexTerm>:</Term>
1942 <ListItem>
1943 <Para>
1944 similarly for <Constant>&dollar;(C&lowbar;SRCS)</Constant>.
1945 </Para>
1946 </ListItem></VarListEntry>
1947 <VarListEntry>
1948 <Term><Constant>OBJS</Constant><IndexTerm><Primary>OBJS</Primary></IndexTerm>:</Term>
1949 <ListItem>
1950 <Para>
1951 the concatenation of <Constant>&dollar;(HS&lowbar;OBJS)</Constant> and <Constant>&dollar;(C&lowbar;OBJS)</Constant>.
1952 </Para>
1953 </ListItem></VarListEntry>
1954 </VariableList>
1955 </Para>
1956
1957 <Para>
1958 Any or all of these definitions can easily be overriden by giving new
1959 definitions in your <Filename>Makefile</Filename>.  For example, if there are things in
1960 the current directory that look like source files but aren't, then
1961 you'll need to set <Constant>SRCS</Constant> manually in your <Filename>Makefile</Filename>.  The other
1962 definitions will then work from this new definition.
1963 </Para>
1964
1965 <Para>
1966 What, exactly, does <Filename>paths.mk</Filename> consider a ``source file'' to be?  It's
1967 based on the file's suffix (e.g. <Filename>.hs</Filename>, <Filename>.lhs</Filename>, <Filename>.c</Filename>, <Filename>.lc</Filename>, etc), but
1968 this is the kind of detail that changes, so rather than
1969 enumerate the source suffices here the best thing to do is to look in
1970 <Filename>paths.mk</Filename>.
1971 </Para>
1972 </ListItem></VarListEntry>
1973 <VarListEntry>
1974 <Term><Filename>opts.mk</Filename><IndexTerm><Primary>opts.mk</Primary></IndexTerm></Term>
1975 <ListItem>
1976 <Para>
1977 defines <Command>make</Command> variables for option
1978 strings to pass to each program. For example, it defines
1979 <Constant>HC&lowbar;OPTS</Constant><IndexTerm><Primary>HC&lowbar;OPTS</Primary></IndexTerm>, the option strings to pass to the Haskell
1980 compiler.  See <Xref LinkEnd="sec-suffix">.
1981 </Para>
1982 </ListItem></VarListEntry>
1983 <VarListEntry>
1984 <Term><Filename>suffix.mk</Filename><IndexTerm><Primary>suffix.mk</Primary></IndexTerm></Term>
1985 <ListItem>
1986 <Para>
1987 defines standard pattern rules&mdash;see <Xref LinkEnd="sec-suffix">.
1988 </Para>
1989 </ListItem></VarListEntry>
1990 </VariableList>
1991 </Para>
1992
1993 <Para>
1994 Any of the variables and pattern rules defined by the boilerplate file
1995 can easily be overridden in any particular <Filename>Makefile</Filename>, because the
1996 boilerplate <Literal>include</Literal> comes first.  Definitions after this <Literal>include</Literal>
1997 directive simply override the default ones in <Filename>boilerplate.mk</Filename>.
1998 </Para>
1999
2000 </Sect2>
2001
2002 <Sect2 id="sec-suffix">
2003 <Title>Pattern rules and options
2004
2005 <IndexTerm><Primary>Pattern rules</Primary></IndexTerm></Title>
2006
2007 <Para>
2008 The file <Filename>suffix.mk</Filename><IndexTerm><Primary>suffix.mk</Primary></IndexTerm> defines standard <Emphasis>pattern
2009 rules</Emphasis> that say how to build one kind of file from another, for
2010 example, how to build a <Filename>.o</Filename> file from a <Filename>.c</Filename> file.  (GNU <Command>make</Command>'s
2011 <Emphasis>pattern rules</Emphasis> are more powerful and easier to use than Unix
2012 <Command>make</Command>'s <Emphasis>suffix rules</Emphasis>.)
2013 </Para>
2014
2015 <Para>
2016 Almost all the rules look something like this:
2017 </Para>
2018
2019 <Para>
2020
2021 <ProgramListing>
2022 %.o : %.c
2023       $(RM) $@
2024       $(CC) $(CC_OPTS) -c $&#60; -o $@
2025 </ProgramListing>
2026
2027 </Para>
2028
2029 <Para>
2030 Here's how to understand the rule.  It says that
2031 <Emphasis>something</Emphasis><Filename>.o</Filename> (say <Filename>Foo.o</Filename>) can be built from
2032 <Emphasis>something</Emphasis><Filename>.c</Filename> (<Filename>Foo.c</Filename>), by invoking the C compiler
2033 (path name held in <Constant>&dollar;(CC)</Constant>), passing to it the options
2034 <Constant>&dollar;(CC&lowbar;OPTS)</Constant> and the rule's dependent file of the rule
2035 <Literal>&dollar;&lt;</Literal> (<Filename>Foo.c</Filename> in this case), and putting the result in
2036 the rule's target <Literal>&dollar;@</Literal> (<Filename>Foo.o</Filename> in this case).
2037 </Para>
2038
2039 <Para>
2040 Every program is held in a <Command>make</Command> variable defined in
2041 <Filename>mk/config.mk</Filename>&mdash;look in <Filename>mk/config.mk</Filename> for the
2042 complete list.  One important one is the Haskell compiler, which is
2043 called <Constant>&dollar;(HC)</Constant>.
2044 </Para>
2045
2046 <Para>
2047 Every program's options are are held in a <Command>make</Command> variables called
2048 <Constant>&lt;prog&gt;&lowbar;OPTS</Constant>.  the <Constant>&lt;prog&gt;&lowbar;OPTS</Constant> variables are defined in
2049 <Filename>mk/opts.mk</Filename>.  Almost all of them are defined like this:
2050 </Para>
2051
2052 <Para>
2053
2054 <ProgramListing>
2055 CC_OPTS = $(SRC_CC_OPTS) $(WAY$(_way)_CC_OPTS) $($*_CC_OPTS) $(EXTRA_CC_OPTS)
2056 </ProgramListing>
2057
2058 </Para>
2059
2060 <Para>
2061 The four variables from which <Constant>CC&lowbar;OPTS</Constant> is built have the following meaning:
2062 </Para>
2063
2064 <Para>
2065 <VariableList>
2066
2067 <VarListEntry>
2068 <Term><Constant>SRC&lowbar;CC&lowbar;OPTS</Constant><IndexTerm><Primary>SRC&lowbar;CC&lowbar;OPTS</Primary></IndexTerm>:</Term>
2069 <ListItem>
2070 <Para>
2071 options passed to all C
2072 compilations.
2073 </Para>
2074 </ListItem></VarListEntry>
2075 <VarListEntry>
2076 <Term><Constant>WAY&lowbar;&lt;way&gt;&lowbar;CC&lowbar;OPTS</Constant>:</Term>
2077 <ListItem>
2078 <Para>
2079 options passed to C
2080 compilations for way <Literal>&lt;way&gt;</Literal>. For example,
2081 <Constant>WAY&lowbar;mp&lowbar;CC&lowbar;OPTS</Constant> gives options to pass to the C compiler when
2082 compiling way <Literal>mp</Literal>.  The variable <Constant>WAY&lowbar;CC&lowbar;OPTS</Constant> holds
2083 options to pass to the C compiler when compiling the standard way.
2084 (<Xref LinkEnd="sec-ways"> dicusses multi-way
2085 compilation.)
2086 </Para>
2087 </ListItem></VarListEntry>
2088 <VarListEntry>
2089 <Term><Constant>&lt;module&gt;&lowbar;CC&lowbar;OPTS</Constant>:</Term>
2090 <ListItem>
2091 <Para>
2092 options to
2093 pass to the C compiler that are specific to module <Literal>&lt;module&gt;</Literal>.  For example, <Constant>SMap&lowbar;CC&lowbar;OPTS</Constant> gives the specific options
2094 to pass to the C compiler when compiling <Filename>SMap.c</Filename>.
2095 </Para>
2096 </ListItem></VarListEntry>
2097 <VarListEntry>
2098 <Term><Constant>EXTRA&lowbar;CC&lowbar;OPTS</Constant><IndexTerm><Primary>EXTRA&lowbar;CC&lowbar;OPTS</Primary></IndexTerm>:</Term>
2099 <ListItem>
2100 <Para>
2101 extra options to pass to all
2102 C compilations.  This is intended for command line use, thus:
2103 </Para>
2104
2105 <Para>
2106
2107 <ProgramListing>
2108 gmake libHS.a EXTRA_CC_OPTS="-v"
2109 </ProgramListing>
2110
2111 </Para>
2112 </ListItem></VarListEntry>
2113 </VariableList>
2114 </Para>
2115
2116 </Sect2>
2117
2118 <Sect2 id="sec-targets">
2119 <Title>The main <Filename>mk/target.mk</Filename> file
2120
2121 <IndexTerm><Primary>target.mk</Primary></IndexTerm></Title>
2122
2123 <Para>
2124 <Filename>target.mk</Filename> contains canned rules for all the standard targets
2125 described in <Xref LinkEnd="sec-standard-targets">.  It is complicated by the fact that you don't want all of
2126 these rules to be active in every <Filename>Makefile</Filename>.  Rather than have a
2127 plethora of tiny files which you can include selectively, there is a
2128 single file, <Filename>target.mk</Filename>, which selectively includes rules based on
2129 whether you have defined certain variables in your <Filename>Makefile</Filename>.  This
2130 section explains what rules you get, what variables control them, and
2131 what the rules do.  Hopefully, you will also get enough of an idea of
2132 what is supposed to happen that you can read and understand any weird
2133 special cases yourself.
2134 </Para>
2135
2136 <Para>
2137 <VariableList>
2138
2139 <VarListEntry>
2140 <Term><Constant>HS&lowbar;PROG</Constant><IndexTerm><Primary>HS&lowbar;PROG</Primary></IndexTerm>.</Term>
2141 <ListItem>
2142 <Para>
2143 If <Constant>HS&lowbar;PROG</Constant> is defined, you get
2144 rules with the following targets:
2145 <VariableList>
2146
2147 <VarListEntry>
2148 <Term><Filename>HS&lowbar;PROG</Filename><IndexTerm><Primary>HS&lowbar;PROG</Primary></IndexTerm></Term>
2149 <ListItem>
2150 <Para>
2151 itself.  This rule links <Constant>&dollar;(OBJS)</Constant>
2152 with the Haskell runtime system to get an executable called
2153 <Constant>&dollar;(HS&lowbar;PROG)</Constant>.
2154 </Para>
2155 </ListItem></VarListEntry>
2156 <VarListEntry>
2157 <Term><Literal>install</Literal><IndexTerm><Primary>install</Primary></IndexTerm></Term>
2158 <ListItem>
2159 <Para>
2160 installs <Constant>&dollar;(HS&lowbar;PROG)</Constant>
2161 in <Constant>&dollar;(bindir)</Constant>.
2162 </Para>
2163 </ListItem></VarListEntry>
2164 </VariableList>
2165 </Para>
2166 </ListItem></VarListEntry>
2167 <VarListEntry>
2168 <Term><Constant>C&lowbar;PROG</Constant><IndexTerm><Primary>C&lowbar;PROG</Primary></IndexTerm></Term>
2169 <ListItem>
2170 <Para>
2171 is similar to <Constant>HS&lowbar;PROG</Constant>, except that
2172 the link step links <Constant>&dollar;(C&lowbar;OBJS)</Constant> with the C runtime system.
2173 </Para>
2174 </ListItem></VarListEntry>
2175 <VarListEntry>
2176 <Term><Constant>LIBRARY</Constant><IndexTerm><Primary>LIBRARY</Primary></IndexTerm></Term>
2177 <ListItem>
2178 <Para>
2179 is similar to <Constant>HS&lowbar;PROG</Constant>, except that
2180 it links <Constant>&dollar;(LIB&lowbar;OBJS)</Constant> to make the library archive <Constant>&dollar;(LIBRARY)</Constant>, and
2181 <Literal>install</Literal> installs it in <Constant>&dollar;(libdir)</Constant>.
2182 </Para>
2183 </ListItem></VarListEntry>
2184 <VarListEntry>
2185 <Term><Constant>LIB&lowbar;DATA</Constant><IndexTerm><Primary>LIB&lowbar;DATA</Primary></IndexTerm></Term>
2186 <ListItem>
2187 <Para>
2188 &hellip;
2189 </Para>
2190 </ListItem></VarListEntry>
2191 <VarListEntry>
2192 <Term><Constant>LIB&lowbar;EXEC</Constant><IndexTerm><Primary>LIB&lowbar;EXEC</Primary></IndexTerm></Term>
2193 <ListItem>
2194 <Para>
2195 &hellip;
2196 </Para>
2197 </ListItem></VarListEntry>
2198 <VarListEntry>
2199 <Term><Constant>HS&lowbar;SRCS</Constant><IndexTerm><Primary>HS&lowbar;SRCS</Primary></IndexTerm>, <Constant>C&lowbar;SRCS</Constant><IndexTerm><Primary>C&lowbar;SRCS</Primary></IndexTerm>.</Term>
2200 <ListItem>
2201 <Para>
2202 If <Constant>HS&lowbar;SRCS</Constant>
2203 is defined and non-empty, a rule for the target <Literal>depend</Literal> is included,
2204 which generates dependency information for Haskell programs.
2205 Similarly for <Constant>C&lowbar;SRCS</Constant>.
2206 </Para>
2207 </ListItem></VarListEntry>
2208 </VariableList>
2209 </Para>
2210
2211 <Para>
2212 All of these rules are ``double-colon'' rules, thus
2213 </Para>
2214
2215 <Para>
2216
2217 <ProgramListing>
2218 install :: $(HS_PROG)
2219       ...how to install it...
2220 </ProgramListing>
2221
2222 </Para>
2223
2224 <Para>
2225 GNU <Command>make</Command> treats double-colon rules as separate entities.  If there
2226 are several double-colon rules for the same target it takes each in
2227 turn and fires it if its dependencies say to do so.  This means that
2228 you can, for example, define both <Constant>HS&lowbar;PROG</Constant> and <Constant>LIBRARY</Constant>, which will
2229 generate two rules for <Literal>install</Literal>.  When you type <Command>gmake install</Command> both
2230 rules will be fired, and both the program and the library will be
2231 installed, just as you wanted.
2232 </Para>
2233
2234 </Sect2>
2235
2236 <Sect2 id="sec-subdirs">
2237 <Title>Recursion
2238
2239 <IndexTerm><Primary>recursion, in makefiles</Primary></IndexTerm>
2240 <IndexTerm><Primary>Makefile, recursing into subdirectories</Primary></IndexTerm></Title>
2241
2242 <Para>
2243 In leaf <Filename>Makefile</Filename>s the variable <Constant>SUBDIRS</Constant><IndexTerm><Primary>SUBDIRS</Primary></IndexTerm> is undefined.
2244 In non-leaf <Filename>Makefile</Filename>s, <Constant>SUBDIRS</Constant> is set to the list of
2245 sub-directories that contain subordinate <Filename>Makefile</Filename>s.  <Emphasis>It is up to
2246 you to set <Constant>SUBDIRS</Constant> in the <Filename>Makefile</Filename>.</Emphasis> There is no automation here&mdash;<Constant>SUBDIRS</Constant> is too important to automate.
2247 </Para>
2248
2249 <Para>
2250 When <Constant>SUBDIRS</Constant> is defined, <Filename>target.mk</Filename> includes a rather
2251 neat rule for the standard targets (<Xref LinkEnd="sec-standard-targets"> that simply invokes
2252 <Command>make</Command> recursively in each of the sub-directories.
2253 </Para>
2254
2255 <Para>
2256 <Emphasis>These recursive invocations are guaranteed to occur in the order
2257 in which the list of directories is specified in <Constant>SUBDIRS</Constant>. </Emphasis>This
2258 guarantee can be important.  For example, when you say <Command>gmake boot</Command> it
2259 can be important that the recursive invocation of <Command>make boot</Command> is done
2260 in one sub-directory (the include files, say) before another (the
2261 source files).  Generally, put the most independent sub-directory
2262 first, and the most dependent last.
2263 </Para>
2264
2265 </Sect2>
2266
2267 <Sect2 id="sec-ways">
2268 <Title>Way management
2269
2270 <IndexTerm><Primary>way management</Primary></IndexTerm></Title>
2271
2272 <Para>
2273 We sometimes want to build essentially the same system in several
2274 different ``ways''.  For example, we want to build GHC's <Literal>Prelude</Literal>
2275 libraries with and without profiling, with and without concurrency,
2276 and so on, so that there is an appropriately-built library archive to
2277 link with when the user compiles his program.  It would be possible to
2278 have a completely separate build tree for each such ``way'', but it
2279 would be horribly bureaucratic, especially since often only parts of
2280 the build tree need to be constructed in multiple ways.
2281 </Para>
2282
2283 <Para>
2284 Instead, the <Filename>target.mk</Filename><IndexTerm><Primary>target.mk</Primary></IndexTerm> contains some clever magic to
2285 allow you to build several versions of a system; and to control
2286 locally how many versions are built and how they differ.  This section
2287 explains the magic.
2288 </Para>
2289
2290 <Para>
2291 The files for a particular way are distinguished by munging the
2292 suffix.  The ``normal way'' is always built, and its files have the
2293 standard suffices <Filename>.o</Filename>, <Filename>.hi</Filename>, and so on.  In addition, you can build
2294 one or more extra ways, each distinguished by a <Emphasis>way tag</Emphasis>.  The
2295 object files and interface files for one of these extra ways are
2296 distinguished by their suffix.  For example, way <Literal>mp</Literal> has files
2297 <Filename>.mp&lowbar;o</Filename> and <Filename>.mp&lowbar;hi</Filename>.  Library archives have their way tag the other
2298 side of the dot, for boring reasons; thus, <Filename>libHS&lowbar;mp.a</Filename>.
2299 </Para>
2300
2301 <Para>
2302 A <Command>make</Command> variable called <Constant>way</Constant> holds the current way tag.  <Emphasis><Constant>way</Constant>
2303 is only ever set on the command line of a recursive invocation of
2304 <Command>gmake</Command>.</Emphasis> It is never set inside a <Filename>Makefile</Filename>.  So it is a global
2305 constant for any one invocation of <Command>gmake</Command>.  Two other <Command>make</Command>
2306 variables, <Constant>way&lowbar;</Constant> and <Constant>&lowbar;way</Constant> are immediately derived from <Constant>&dollar;(way)</Constant> and
2307 never altered.  If <Constant>way</Constant> is not set, then neither are <Constant>way&lowbar;</Constant> and
2308 <Constant>&lowbar;way</Constant>, and the invocation of <Command>make</Command> will build the ``normal way''.
2309 If <Constant>way</Constant> is set, then the other two variables are set in sympathy.
2310 For example, if <Constant>&dollar;(way)</Constant> is ``<Literal>mp</Literal>'', then <Constant>way&lowbar;</Constant> is set to ``<Literal>mp&lowbar;</Literal>''
2311 and <Constant>&lowbar;way</Constant> is set to ``<Literal>&lowbar;mp</Literal>''.  These three variables are then used
2312 when constructing file names.
2313 </Para>
2314
2315 <Para>
2316 So how does <Command>make</Command> ever get recursively invoked with <Constant>way</Constant> set?  There
2317 are two ways in which this happens:
2318 </Para>
2319
2320 <Para>
2321
2322 <ItemizedList>
2323 <ListItem>
2324
2325 <Para>
2326  For some (but not all) of the standard targets, when in a leaf
2327 sub-directory, <Command>make</Command> is recursively invoked for each way tag in
2328 <Constant>&dollar;(WAYS)</Constant>.  You set <Constant>WAYS</Constant> to the list of way tags you want these
2329 targets built for.  The mechanism here is very much like the recursive
2330 invocation of <Command>make</Command> in sub-directories (<Xref LinkEnd="sec-subdirs">).
2331
2332 It is up to you to set <Constant>WAYS</Constant> in your <Filename>Makefile</Filename>; this is how you
2333 control what ways will get built.
2334 </Para>
2335 </ListItem>
2336 <ListItem>
2337
2338 <Para>
2339  For a useful collection of
2340 targets (such as <Filename>libHS&lowbar;mp.a</Filename>, <Filename>Foo.mp&lowbar;o</Filename>) there is a rule which
2341 recursively invokes <Command>make</Command> to make the specified target, setting the
2342 <Constant>way</Constant> variable.  So if you say <Command>gmake Foo.mp&lowbar;o</Command> you should see a
2343 recursive invocation <Command>gmake Foo.mp&lowbar;o way=mp</Command>, and <Emphasis>in this
2344 recursive invocation the pattern rule for compiling a Haskell file
2345 into a <Filename>.o</Filename> file will match</Emphasis>.  The key pattern rules (in <Filename>suffix.mk</Filename>)
2346 look like this:
2347
2348
2349 <ProgramListing>
2350 %.$(way_)o : %.lhs
2351       $(HC) $(HC_OPTS) $&#60; -o $@
2352 </ProgramListing>
2353
2354
2355 Neat, eh?
2356 </Para>
2357 </ListItem>
2358
2359 </ItemizedList>
2360
2361 </Para>
2362
2363 </Sect2>
2364
2365 <Sect2>
2366 <Title>When the canned rule isn't right</Title>
2367
2368 <Para>
2369 Sometimes the canned rule just doesn't do the right thing.  For
2370 example, in the <Literal>nofib</Literal> suite we want the link step to print out
2371 timing information.  The thing to do here is <Emphasis>not</Emphasis> to define
2372 <Constant>HS&lowbar;PROG</Constant> or <Constant>C&lowbar;PROG</Constant>, and instead define a special purpose rule in
2373 your own <Filename>Makefile</Filename>.  By using different variable names you will avoid
2374 the canned rules being included, and conflicting with yours.
2375 </Para>
2376
2377 </Sect2>
2378
2379 </Sect1>
2380
2381 <Sect1 id="sec-booting-from-C">
2382 <Title>Booting/porting from C (<Filename>.hc</Filename>) files
2383
2384 <IndexTerm><Primary>building GHC from .hc files</Primary></IndexTerm>
2385 <IndexTerm><Primary>booting GHC from .hc files</Primary></IndexTerm>
2386 <IndexTerm><Primary>porting GHC</Primary></IndexTerm></Title>
2387
2388 <Para>
2389 This section is for people trying to get GHC going by using the
2390 supplied intermediate C (<Filename>.hc</Filename>) files.  This would probably be because
2391 no binaries have been provided, or because the machine is not ``fully
2392 supported''.
2393 </Para>
2394
2395 <Para>
2396 The intermediate C files are normally made available together with a
2397 source release, please check the announce message for exact directions
2398 of where to find them. If we haven't made them available or you
2399 can't find them, please ask.
2400 </Para>
2401
2402 <Para>
2403 Assuming you've got them, unpack them on top of a fresh source tree.
2404 Then follow the `normal' instructions in <Xref LinkEnd="sec-building-from-source"> for setting
2405 up a build tree. When you invoke the configure script, you'll have
2406 to tell the script about your intentions:
2407 </Para>
2408
2409 <Para>
2410
2411 <Screen>
2412 foo% ./configure --enable-hc-boot
2413 </Screen>
2414
2415 <IndexTerm><Primary>--enable-hc-boot</Primary></IndexTerm>
2416 <IndexTerm><Primary>--disable-hc-boot</Primary></IndexTerm>
2417 </Para>
2418
2419 <Para>
2420 Assuming it configures OK and you don't need to create <Filename>mk/build.mk</Filename>
2421 for any other purposes, the next step is to proceed with a <Command>make boot</Command>
2422 followed by <Command>make all</Command>. At the successful completion of <Command>make all</Command>,
2423 you should end up with a binary of the compiler proper,
2424 <Filename>ghc/compiler/hsc</Filename>, plus archives (but no <Filename>.hi</Filename> files!) of the prelude
2425 libraries. To generate the Prelude interface files (and test drive the
2426 bootstrapped compiler), re-run the <Command>configure</Command> script, but this time
2427 without the <Option>--enable-hc-boot</Option> option. After that re-create the
2428 contents of <Filename>ghc/lib</Filename>:
2429 </Para>
2430
2431 <Para>
2432
2433 <Screen>
2434 foo% ./configure
2435  ....
2436 foo% cd ghc/lib
2437 foo% make clean
2438 foo% make boot
2439 foo% make all
2440 </Screen>
2441
2442 </Para>
2443
2444 <Para>
2445 That's the mechanics of the boot process, but, of course, if you're
2446 trying to boot on a platform that is not supported and significantly
2447 `different' from any of the supported ones, this is only the start of
2448 the adventure&hellip;(ToDo: porting tips&mdash;stuff to look out for, etc.)
2449 </Para>
2450
2451 </Sect1>
2452
2453 <Sect1 id="sec-build-pitfalls">
2454 <Title>Known pitfalls in building Glasgow Haskell
2455
2456 <IndexTerm><Primary>problems, building</Primary></IndexTerm>
2457 <IndexTerm><Primary>pitfalls, in building</Primary></IndexTerm>
2458 <IndexTerm><Primary>building pitfalls</Primary></IndexTerm></Title>
2459
2460 <Para>
2461 WARNINGS about pitfalls and known ``problems'':
2462 </Para>
2463
2464 <Para>
2465
2466 <OrderedList>
2467 <ListItem>
2468
2469 <Para>
2470 One difficulty that comes up from time to time is running out of space
2471 in <Filename>/tmp</Filename>.  (It is impossible for the configuration stuff to
2472 compensate for the vagaries of different sysadmin approaches to temp
2473 space.)
2474 <IndexTerm><Primary>tmp, running out of space in</Primary></IndexTerm>
2475
2476 The quickest way around it is <Command>setenv TMPDIR /usr/tmp</Command><IndexTerm><Primary>TMPDIR</Primary></IndexTerm> or
2477 even <Command>setenv TMPDIR .</Command> (or the equivalent incantation with your shell
2478 of choice).
2479
2480 The best way around it is to say
2481
2482 <ProgramListing>
2483 export TMPDIR=&#60;dir&#62;
2484 </ProgramListing>
2485
2486 in your <Filename>build.mk</Filename> file.
2487 Then GHC and the other <Literal>fptools</Literal> programs will use the appropriate directory
2488 in all cases.
2489
2490
2491 </Para>
2492 </ListItem>
2493 <ListItem>
2494
2495 <Para>
2496 In compiling some support-code bits, e.g., in <Filename>ghc/rts/gmp</Filename> and even
2497 in <Filename>ghc/lib</Filename>, you may get a few C-compiler warnings.  We think these
2498 are OK.
2499
2500 </Para>
2501 </ListItem>
2502 <ListItem>
2503
2504 <Para>
2505 When compiling via C, you'll sometimes get ``warning: assignment from
2506 incompatible pointer type'' out of GCC.  Harmless.
2507
2508 </Para>
2509 </ListItem>
2510 <ListItem>
2511
2512 <Para>
2513 Similarly, <Command>ar</Command>chiving warning messages like the following are not
2514 a problem:
2515
2516 <Screen>
2517 ar: filename GlaIOMonad__1_2s.o truncated to GlaIOMonad_
2518 ar: filename GlaIOMonad__2_2s.o truncated to GlaIOMonad_
2519 ...
2520 </Screen>
2521
2522
2523 </Para>
2524 </ListItem>
2525 <ListItem>
2526
2527 <Para>
2528  In compiling the compiler proper (in <Filename>compiler/</Filename>), you <Emphasis>may</Emphasis>
2529 get an ``Out of heap space'' error message.  These can vary with the
2530 vagaries of different systems, it seems.  The solution is simple:
2531
2532
2533 <ItemizedList>
2534 <ListItem>
2535
2536 <Para>
2537  If you're compiling with GHC 4.00 or later, then the
2538 <Emphasis>maximum</Emphasis> heap size must have been reached.  This
2539 is somewhat unlikely, since the maximum is set to 64M by default.
2540 Anyway, you can raise it with the
2541 <Option>-optCrts-M&lt;size&gt;</Option> flag (add this flag to
2542 <Constant>&lt;module&gt;&lowbar;HC&lowbar;OPTS</Constant>
2543 <Command>make</Command> variable in the appropriate
2544 <Filename>Makefile</Filename>).
2545
2546 </Para>
2547 </ListItem>
2548 <ListItem>
2549
2550 <Para>
2551  For GHC &#60; 4.00, add a suitable <Option>-H</Option> flag to the <Filename>Makefile</Filename>, as
2552 above.
2553
2554 </Para>
2555 </ListItem>
2556
2557 </ItemizedList>
2558
2559
2560 and try again: <Command>gmake</Command>.  (see <Xref LinkEnd="sec-suffix"> for information about
2561 <Constant>&lt;module&gt;&lowbar;HC&lowbar;OPTS</Constant>.)
2562
2563 Alternatively, just cut to the chase:
2564
2565 <Screen>
2566 % cd ghc/compiler
2567 % make EXTRA_HC_OPTS=-optCrts-M128M
2568 </Screen>
2569
2570
2571 </Para>
2572 </ListItem>
2573 <ListItem>
2574
2575 <Para>
2576 If you try to compile some Haskell, and you get errors from GCC about
2577 lots of things from <Filename>/usr/include/math.h</Filename>, then your GCC was
2578 mis-installed.  <Command>fixincludes</Command> wasn't run when it should've been.
2579
2580 As <Command>fixincludes</Command> is now automagically run as part of GCC installation,
2581 this bug also suggests that you have an old GCC.
2582
2583
2584 </Para>
2585 </ListItem>
2586 <ListItem>
2587
2588 <Para>
2589 You <Emphasis>may</Emphasis> need to re-<Command>ranlib</Command><IndexTerm><Primary>ranlib</Primary></IndexTerm> your libraries (on Sun4s).
2590
2591
2592 <Screen>
2593 % cd $(libdir)/ghc-x.xx/sparc-sun-sunos4
2594 % foreach i ( `find . -name '*.a' -print` ) # or other-shell equiv...
2595 ?    ranlib $i
2596 ?    # or, on some machines: ar s $i
2597 ? end
2598 </Screen>
2599
2600
2601 We'd be interested to know if this is still necessary.
2602
2603
2604 </Para>
2605 </ListItem>
2606 <ListItem>
2607
2608 <Para>
2609 GHC's sources go through <Command>cpp</Command> before being compiled, and <Command>cpp</Command> varies
2610 a bit from one Unix to another.  One particular gotcha is macro calls
2611 like this:
2612
2613
2614 <ProgramListing>
2615 SLIT("Hello, world")
2616 </ProgramListing>
2617
2618
2619 Some <Command>cpp</Command>s treat the comma inside the string as separating two macro
2620 arguments, so you get
2621
2622
2623 <Screen>
2624 :731: macro `SLIT' used with too many (2) args
2625 </Screen>
2626
2627
2628 Alas, <Command>cpp</Command> doesn't tell you the offending file!
2629
2630 Workaround: don't put weird things in string args to <Command>cpp</Command> macros.
2631 </Para>
2632 </ListItem>
2633
2634 </OrderedList>
2635
2636 </Para>
2637
2638 </Sect1>
2639
2640
2641 <Sect1 id="winbuild"><Title>Notes for building under Windows</Title>
2642
2643 <Para>
2644 This section summarises how to get the utilities you need on your
2645 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&oslash;rn Finne.
2646 </Para>
2647
2648
2649 <Sect2><Title>Installing ssh</Title>
2650
2651 <ItemizedList>
2652
2653 <ListItem>
2654 <Para>
2655 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.
2656 </Para>
2657 </ListItem>
2658
2659 <ListItem>
2660 <Para>
2661 Extract <ULink URL="http://research.microsoft.com/~simonpj/cygwinb19.dll.zip">cygwinb19.dll</ULink> into <Filename>/usr/local/bin</Filename>.  The current version
2662 of Cywin is b20, but this version of ssh was compiled with b19.
2663 </Para>
2664 </ListItem>
2665
2666 <ListItem>
2667 <Para>
2668 On a Win2k machine, open up a bash and do
2669 </Para>
2670
2671 <Screen>
2672 foo$ cd /etc
2673 foo$ mkpasswd -l > passwd
2674 </Screen>
2675
2676 <Para>
2677 Check that your login entry is on the first line
2678 of that file. If not, move it to the top.  It's OK
2679 for 'Administrator' to be the first entry, assuming you are one.
2680 </Para>
2681
2682 <Para>
2683 However, Win9x doesn't support the calls that <Command>mkpasswd</Command> relies on
2684 (e.g., <Function>NetUserEnum</Function>). If you run <Command>mkpasswd</Command> you
2685 get errors like:
2686 </Para>
2687
2688 <Screen>
2689 linked to missing export netapi32.dll:NetUserEnum
2690 </Screen>
2691
2692 <Para>
2693 The passwd file is used
2694 by ssh in a fairly rudimentary manner, so I'd simply
2695 synthesise/copy an existing Unix <Filename>/etc/passwd</Filename>, i.e., create
2696 an <Filename>/etc/passwd</Filename> file containing the line
2697 </Para>
2698
2699 <Screen>
2700 &lt;login&gt;::500:513:::/bin/sh
2701 </Screen>
2702
2703 <Para>
2704 where <Literal>&lt;login&gt;</Literal> is your login id.
2705 </Para>
2706 </ListItem>
2707
2708 <ListItem>
2709 <Para>
2710 Generate a key, by running <Filename>c:/user/local/bin/ssh-keygen1</Filename>.
2711   This generates a public key in <Filename>.ssh/identity.pub</Filename>, and a
2712   private key in <Filename>.ssh/identity</Filename>
2713 </Para>
2714
2715 <Para>
2716   In response to the 'Enter passphrase' question, just hit
2717   return (i.e. use an empty passphrase).  The passphrase is
2718   a password that protects your private key.  But it's a pain
2719   to type this passphrase everytime you use <Command>ssh</Command>, so the best
2720   thing to do is simply to protect your <Filename>.ssh</Filename> directory, and
2721   <Filename>.ssh/identity</Filename> from access by anyone else.  To do this
2722   right-click your <Filename>.ssh</Filename> directory, and select Properties.
2723   If you are not on the access control list, add yourself, and
2724   give yourself full permissions (the second panel).
2725   Remove everyone else from the access control list.  (Don't
2726   leave them there but deny them access, because 'they' may be
2727   a list that includes you!)
2728 </Para>
2729
2730 <Para>
2731   If you have problems running <Command>ssh-keygen1</Command>
2732   from within <Command>bash</Command>, start up <Filename>cmd.exe</Filename> and run it as follows:
2733 </Para>
2734
2735 <Screen>
2736 c:\tmp> set CYGWIN32=tty
2737 c:\tmp> c:/user/local/bin/ssh-keygen1
2738 </Screen>
2739 </ListItem>
2740
2741 <ListItem>
2742 <Para>
2743 If you don't have an account on <Literal>cvs.haskell.org</Literal>, send
2744   your <Filename>.ssh/identity.pub</Filename> to the CVS repository administrator
2745   (currently Jeff Lewis <Email>jlewis@cse.ogi.edu</Email>).  He will set up
2746   your account.
2747 </Para>
2748
2749 <Para>
2750   If you do have an account on <Literal>cvs.haskell.org</Literal>, use TeraTerm
2751   to logon to it. Once in, copy the
2752   key that <Command>ssh-keygen1</Command> deposited in <Filename>/.ssh/identity.pub</Filename> into
2753   your <Filename>~/.ssh/authorized_keys</Filename>. Make sure that the new version
2754   of <Filename>authorized_keys</Filename> still has 600 file permission.
2755 </Para>
2756 </ListItem>
2757
2758 </ItemizedList>
2759
2760 </Sect2>
2761
2762
2763 <Sect2><Title>Installing CVS</Title>
2764
2765 <ItemizedList>
2766
2767 <ListItem>
2768 <Para>
2769 Unpack
2770 <ULink URL="http://research.microsoft.com/~simonpj/cvs-1_10-win.zip">
2771 CVS</ULink> and, following the instructions in the <Filename>README</Filename>, copy the
2772 appropriate files into <Filename>/usr/local/bin</Filename>.
2773 </Para>
2774 </ListItem>
2775
2776 <ListItem>
2777 <Para>
2778 From the System control panel,
2779 set the following <Emphasis>user</Emphasis> environment variables (see the GHC user guide)
2780 </Para>
2781
2782 <ItemizedList>
2783 <ListItem>
2784 <Para>
2785 <Constant>HOME</Constant>: points to your home directory.  This is where CVS
2786 will look for its <Filename>.cvsrc</Filename> file.
2787 </Para>
2788 </ListItem>
2789
2790 <ListItem>
2791 <Para>
2792 <Constant>CVS_RSH</Constant>: <Filename>c:/usr/local/bin/ssh1</Filename>
2793 </Para>
2794 </ListItem>
2795
2796 <ListItem>
2797 <Para>
2798 <Constant>CVSROOT</Constant>: <Literal>:ext:username@cvs.haskell.org:/home/cvs/root</Literal>,
2799 where <Literal>username</Literal> is your userid
2800 </Para>
2801 </ListItem>
2802
2803 <ListItem>
2804 <Para>
2805 <Constant>CVSEDITOR</Constant>: <Filename>bin/gnuclient.exe</Filename> if you want to use an Emacs buffer for typing in those long commit messages.
2806 </Para>
2807 </ListItem>
2808 </ItemizedList>
2809 </ListItem>
2810
2811 <ListItem>
2812 <Para>
2813 Put the following in <Filename>$HOME/.cvsrc</Filename>:
2814 </Para>
2815
2816 <ProgramListing>
2817 checkout -P
2818 release -d
2819 update -P
2820 diff -u
2821 </ProgramListing>
2822
2823 <Para>
2824 These are the default options for the specified CVS commands,
2825 and represent better defaults than the usual ones.  (Feel
2826 free to change them.)
2827 </Para>
2828
2829 <Para>
2830 Filenames starting with "<Filename>.</Filename>" were illegal in
2831 the 8.3 DOS filesystem, but that restriction should have
2832 been lifted by now (i.e., you're using VFAT or later filesystems.) If
2833 you're still having problems creating it, don't worry; <Filename>.cvsrc</Filename> is entirely
2834 optional.
2835 </Para>
2836 </ListItem>
2837
2838 <ListItem>
2839 <Para>
2840 Try doing <Command>cvs co fpconfig</Command>. All being well, bytes should
2841 start to trickle through, leaving a directory <Filename>fptools</Filename>
2842 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:
2843 </Para>
2844
2845 <Screen>
2846 setsockopt IPTOS_LOWDELAY: Invalid argument
2847 setsockopt IPTOS_THROUGHPUT: Invalid argument
2848 </Screen>
2849
2850 <Para>
2851 At this point I found that CVS tried to invoke a little dialogue with
2852 me (along the lines of `do you want to talk to this host'), but
2853 somehow bombed out.  This was from a bash shell running in emacs.
2854 I solved this by invoking a Cygnus shell, and running CVS from there.
2855 Once things are dialogue free, it seems to work OK from within emacs.
2856 </Para>
2857 </ListItem>
2858
2859 <ListItem>
2860 <Para>
2861 If you want to check out part of large tree, proceed as follows:
2862 </Para>
2863
2864 <ProgramListing>
2865 cvs -f checkout -l papers
2866 cd papers
2867 cvs update cpr
2868 </ProgramListing>
2869
2870 <Para>
2871 This sequence checks out the <Literal>papers</Literal> module, but none
2872 of its sub-directories.
2873 The "<Option>-l</Option>" flag says not to check out sub-directories.
2874 The "<Option>-f</Option>" flag says not to read the <Filename>.cvsrc</Filename> file
2875 whose <Option>-P</Option> default (don't check out empty directories) is
2876 in this case bogus.
2877 </Para>
2878
2879 <Para>
2880 The <Command>cvs update</Command> command sucks in a named sub-directory.
2881 </Para>
2882 </ListItem>
2883
2884 </ItemizedList>
2885
2886 <Para>
2887 There is a very nice graphical front-end to CVS for Win32 platforms,
2888 with a UI that people will be familiar with, at
2889 <ULink URL="http://www.wincvs.org/">wincvs.org</ULink>.
2890 I have not tried it yet.
2891 </Para>
2892
2893 </Sect2>
2894
2895
2896 <Sect2><Title>Installing autoconf</Title>
2897
2898 <Para>
2899 Only required if you are doing builds from GHC's sources
2900 checked out from the CVS tree.
2901 </Para>
2902
2903 <ItemizedList>
2904 <ListItem>
2905 <Para>
2906 Fetch the (standard, Unix) <Command>autoconf</Command> distribution from
2907 <ULink URL="ftp://ftp.gnu.org/gnu/autoconf">ftp.gnu.org</ULink>.
2908 </Para>
2909 </ListItem>
2910 <ListItem>
2911 <Para>
2912 Unpack it into an arbitrary directory.
2913 </Para>
2914 </ListItem>
2915 <ListItem>
2916 <Para>
2917 Make sure that the directory <Filename>/usr/local/bin</Filename> exists.
2918 </Para>
2919 </ListItem>
2920 <ListItem>
2921 <Para>
2922 Say "<Filename>./configure</Filename>".
2923 </Para>
2924 </ListItem>
2925 <ListItem>
2926 <Para>
2927 Now <Command>make install</Command>.  This should put <Filename>autoheader</Filename>
2928 and <Filename>autoconf</Filename> in <Filename>/usr/local/bin</Filename>.
2929 </Para>
2930 </ListItem>
2931 </ItemizedList>
2932
2933 <Para>
2934 <Command>autoheader</Command> doesn't seem to work, but you don't need it
2935 for GHC.
2936 </Para>
2937
2938 </Sect2>
2939
2940
2941 <Sect2><Title>Building GHC</Title>
2942
2943 <ItemizedList>
2944
2945 <ListItem>
2946 <Para>
2947 In the <Filename>./configure</Filename> output, ignore
2948 "<Literal>
2949 checking whether #! works in shell scripts...
2950 ./configure: ./conftest: No such file or directory</Literal>",
2951 and "<Literal>not updating unwritable cache ./config.cache</Literal>".
2952 Nobody knows why these happen, but they seem to be harmless.
2953 </Para>
2954 </ListItem>
2955
2956 <ListItem>
2957 <Para>
2958 You have to run <Command>autoconf</Command> both in <Filename>fptools</Filename>
2959 and in <Filename>fptools/ghc</Filename>.  If you omit the latter step you'll
2960 get an error when you run <Filename>./configure</Filename>:
2961 </Para>
2962
2963 <Screen>
2964 ...lots of stuff...
2965 creating mk/config.h
2966 mk/config.h is unchanged
2967 configuring in ghc
2968 running /bin/sh ./configure  --cache-file=.././config.cache --srcdir=.
2969 ./configure: ./configure: No such file or directory
2970 configure: error: ./configure failed for ghc
2971 </Screen>
2972 </ListItem>
2973
2974 <ListItem>
2975 <Para>
2976 You need <Filename>ghc</Filename> to be in your <Constant>PATH</Constant> before you run
2977 <Command>configure</Command>.  The default GHC InstallShield creates only
2978 <Filename>ghc-4.05</Filename>, so you may need to duplicate this file as <Filename>ghc</Filename>
2979 in the same directory, in order that <Command>configure</Command> will see it (or
2980 just rename <Filename>ghc-4.05</Filename> to <Filename>ghc</Filename>.
2981 And make sure that the directory is in your path.
2982 </Para>
2983 </ListItem>
2984
2985 <ListItem>
2986 <Para>
2987 Compile <Command>happy</Command> and <Command>ghc</Command>
2988 with <Option>-static</Option>.  To do this, set
2989 </Para>
2990
2991 <ProgramListing>
2992 GhcHcOpts=-static
2993 HappyHcOpts=-static
2994 </ProgramListing>
2995
2996 <Para>
2997 in your <Filename>build.mk</Filename> file.
2998 [Actually, I successfully compiled Happy without <Option>-static</Option> on Win2k, but not GHC.]
2999 </Para>
3000 </ListItem>
3001
3002 </ItemizedList>
3003
3004 </Sect2>
3005
3006 </Sect1>
3007
3008 </Article>