X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=docs%2Fbuilding.sgml;h=2c9d107637f4546997beb646e0cbc95d034bcc90;hb=aa104ab9b2d8e4d86e9f0c2d415db8bfd860781c;hp=c89ef050df0e57a4dcb35d3f1632beb879ce68dd;hpb=52d93e1b92bda2dd7a779520d003b672dc037d72;p=ghc-hetmet.git diff --git a/docs/building.sgml b/docs/building.sgml index c89ef05..2c9d107 100644 --- a/docs/building.sgml +++ b/docs/building.sgml @@ -1,6 +1,6 @@ -
+
@@ -172,7 +172,7 @@ manual in detail. - + Things to check before you start typing @@ -182,32 +182,26 @@ Here's a list of things to check before you get started. -Disk space neededDisk space needed: About 30MB (five hamburgers' worth) of disk space -for the most basic binary distribution of GHC; more for some -platforms, e.g., Alphas. An extra ``bundle'' (e.g., concurrent -Haskell libraries) might take you to 8–10 hamburgers. - -You'll need over 100MB (say, 20 hamburgers' worth) if you need to -build the basic stuff from scratch. - - -All of the above are estimates of disk-space needs. (I don't yet -know the disk requirements for the non-GHC tools). - +Disk space needed +Disk space needed: About 40MB (one tenth of one hamburger's worth) of disk +space for the most basic binary distribution of GHC; more for some +platforms, e.g., Alphas. An extra ``bundle'' (e.g., concurrent Haskell +libraries) might take you to up to one fifth of a hamburger. You'll need +over 100MB (say, one fifth a hamburger's worth) if you need to build the +basic stuff from scratch. All of the above are +estimates of disk-space needs. (Note: our benchmark hamburger is a standard Double Whopper with Cheese, with an RRP of UKP2.99.) Use an appropriate machine, compilers, and things. - SPARC boxes, and PCs running Linux, FreeBSD, NetBSD, or Solaris are all fully supported. Win32 and HP boxes are in pretty good shape. DEC Alphas running OSF/1, Linux or some BSD variant, MIPS and AIX boxes will need some minimal porting effort before they work (as of 4.06). gives the full run-down on ports or lack thereof. - @@ -647,19 +641,11 @@ documentation that comes with the fptools projects: DocBook, pre-supposed -All our documentation is written in SGML, using the DocBook DTD and -processed using the Cygnus DocBook -tools, which is the most shrink-wrapped SGML suite that we -could find. You need all the RPMs except for psgml (i.e. docbook, jade, -jadetex, sgmlcommon and stylesheets). Unfortunately, it's only packaged as -RPMs. You can use it to generate HTML, DVI (and hence PDF and Postscript) -and RTF from any DocBook source file (including this manual). N.B. The -Cygnus version of the tools is assumed. Others, such as -the SuSE version, may not work. Note that most of these RPMs are -architecture neutral, so are likely to be found in a noarch -directory. +All our documentation is written in SGML, using the DocBook DTD. +Instructions on installing and configuring the DocBook tools are in the +installation guide (in the GHC user guide). + TeX: @@ -1277,23 +1263,56 @@ install them? That is specified by reverses the effect of install. + clean: -remove all easily-rebuilt files. - +Delete all files from the current directory that are normally +created by building the program. Don't delete the files that +record the configuration. Also preserve files that could be made +by building, but normally aren't because the distribution comes +with them. + + +distclean: + +Delete all files from the current directory that are created by +configuring or building the program. If you have unpacked the source +and built the program without creating any other files, make +distclean should leave only the files that were in the +distribution. + + + + +mostlyclean: + +Like clean, but may refrain from deleting a +few files that people normally don't want to recompile. + + + -veryclean: +maintainer-clean: -remove all files that can be rebuilt at all. -There's a danger here that you may remove a file that needs a more -obscure utility to rebuild it (especially if you started from a source -distribution). - - +Delete everything from the current directory that can be reconstructed +with this Makefile. This typically includes everything deleted by +distclean, plus more: C source files produced by +Bison, tags tables, Info files, and so on. + +One exception, however: make maintainer-clean +should not delete configure even if +configure can be remade using a rule in the +Makefile. More generally, make +maintainer-clean should not delete anything that needs to +exist in order to run configure and then begin to +build the program. + + + check: @@ -1432,7 +1451,7 @@ User's Guide section on "Separate Compilation"). - + The <Filename>Makefile</Filename> architecture <IndexTerm><Primary>makefile architecture</Primary></IndexTerm>