diff options
| -rw-r--r-- | MAKEHELP | 49 | ||||
| -rw-r--r-- | MAKEHELP.md | 81 | ||||
| -rw-r--r-- | SUBMAKEHELP | 33 | ||||
| -rw-r--r-- | ghc.mk | 2 |
4 files changed, 82 insertions, 83 deletions
diff --git a/MAKEHELP b/MAKEHELP deleted file mode 100644 index ab42ddfff9..0000000000 --- a/MAKEHELP +++ /dev/null @@ -1,49 +0,0 @@ - -Using the GHC build system --------------------------- - -For a "Getting Started" guide, see: - - http://ghc.haskell.org/trac/ghc/wiki/Building/Hacking - -Common commands: - - make - - Builds everything: ghc stages 1 and 2, all libraries and tools. - - make -j2 - - Parallel build: runs up to 2 commands at a time (use the number of - CPUs in your machine in place of '2') - - cd <dir>; make - - Builds everything in the given directory. - - cd <dir>; make help - - Shows the targets available in <dir> - - make install - - Installs GHC, libraries and tools under $(prefix) - - make sdist - make binary-dist - - Builds a source or binary distribution respectively - - make show VALUE=<var> - - Displays the value of make variable <var> - - make clean - make distclean - make maintainer-clean - - Various levels of cleaning: "clean" restores the tree to the - state after "./configure", "distclean" restores to the state - after "perl boot", and maintainer-clean restores the tree to the - completely clean checked-out state. - diff --git a/MAKEHELP.md b/MAKEHELP.md new file mode 100644 index 0000000000..ff0e4340a5 --- /dev/null +++ b/MAKEHELP.md @@ -0,0 +1,81 @@ +Quick `make` guide for GHC +========================== + +For a "Getting Started" guide, see: + + http://ghc.haskell.org/trac/ghc/wiki/Building/Hacking + +Common commands: + + - `make` + + Builds everything: ghc stages 1 and 2, all libraries and tools. + + - `make -j2` + + Parallel build: runs up to 2 commands at a time. + + - `cd <dir>; make` + + Builds everything in the given directory. + + - cd <dir>; make help + + Shows the targets available in <dir> + + - make install + + Installs GHC, libraries and tools under $(prefix) + + - make sdist + - make binary-dist + + Builds a source or binary distribution respectively + + - `make show VALUE=<var>` + + Displays the value of make variable <var> + + - make clean + - make distclean + - make maintainer-clean + + Various levels of cleaning: "clean" restores the tree to the + state after "./configure", "distclean" restores to the state + after "perl boot", and maintainer-clean restores the tree to the + completely clean checked-out state. + +Using `make` in subdirectories +============================== + + - `make` + + Builds everything in this directory (including dependencies elsewhere + in the tree, if necessary) + + - `make fast` + + The same as 'make', but omits some phases and does not + recalculate dependencies. Useful for saving time if you are sure + the rest of the tree is up to date. + + - `make clean` + - `make distclean` + - `make maintainer-clean` + + Clean just this directory + + - `make html` + - `make pdf` + - `make ps` + + Make documentation in this directory (if any) + + - `make show VALUE=var` + + Show the value of $(var) + + - `make <file>` + + Bring a particular file up to date, e.g. make dist/build/Module.o + The name <file> is relative to the current directory diff --git a/SUBMAKEHELP b/SUBMAKEHELP deleted file mode 100644 index e109d89ff7..0000000000 --- a/SUBMAKEHELP +++ /dev/null @@ -1,33 +0,0 @@ - - make - - Builds everything in this directory (including dependencies elsewhere - in the tree, if necessary) - - make fast - - The same as 'make', but omits some phases and does not - recalculate dependencies. Useful for saving time if you are sure - the rest of the tree is up to date. - - make clean - make distclean - make maintainer-clean - - Clean just this directory - - make html - make pdf - make ps - - Make documentation in this directory (if any) - - make show VALUE=var - - Show the value of $(var) - - make <file> - - Bring a particular file up to date, e.g. make dist/build/Module.o - The name <file> is relative to the current directory - @@ -1110,7 +1110,7 @@ SRC_DIST_GHC_FILES += \ configure.ac config.guess config.sub configure \ aclocal.m4 README.md ANNOUNCE HACKING.md INSTALL.md LICENSE Makefile install-sh settings.in VERSION GIT_COMMIT_ID \ - boot packages ghc.mk + boot packages ghc.mk MAKEHELP.md .PHONY: VERSION VERSION: |