summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlp Mestanogullari <alpmestan@gmail.com>2019-01-09 12:51:50 +0100
committerBen Gamari <ben@smart-cactus.org>2019-01-16 14:17:28 -0500
commitad5075d938921f85621187752cd1fa4b56813984 (patch)
tree1e4a5e2fe8f4cfa0e46f9d40ea8bc872f88dd903
parent6acb36d8ea169dfc0ddc4e10559a9bf6b4316212 (diff)
downloadhaskell-ad5075d938921f85621187752cd1fa4b56813984.tar.gz
crosslink hadrian/README.md and hadrian/doc/make.md
-rw-r--r--hadrian/README.md9
-rw-r--r--hadrian/doc/make.md6
2 files changed, 13 insertions, 2 deletions
diff --git a/hadrian/README.md b/hadrian/README.md
index a94a51be2b..a3b8a1b2c2 100644
--- a/hadrian/README.md
+++ b/hadrian/README.md
@@ -11,8 +11,6 @@ this [Haskell Symposium 2016 paper](https://dl.acm.org/authorize?N41275) and thi
The new build system can work side-by-side with the existing build system, since it
places all build artefacts in a dedicated directory (called `_build` by default).
-See [this guide](https://ghc.haskell.org/trac/ghc/wiki/Building/Hadrian/QuickStart)
-if you'd like to start using Hadrian for building GHC.
Your first build
----------------
@@ -55,6 +53,13 @@ or already have it, you can use the Cabal-based build script.
* If you have never built GHC before, start with the
[preparation guide][ghc-preparation].
+Cheatsheet for Make users
+-------------------------
+
+You can find a cheatsheet-style document that shows the Hadrian equivalents of
+commands that GHC users are used to run with the Make build system
+[here](doc/make.md).
+
Using the build system
----------------------
Once your first build is successful, simply run `build` to rebuild after some
diff --git a/hadrian/doc/make.md b/hadrian/doc/make.md
index ca4828a484..2a3b432d4a 100644
--- a/hadrian/doc/make.md
+++ b/hadrian/doc/make.md
@@ -1,5 +1,11 @@
# Hadrian for Make users
+This is a cheatsheet-style document meant to succintly show how to use
+Hadrian for any GHC developer familiar with the Make build system, by showing
+the Make command(s) to achieve some goal and then the Hadrian equivalent. If you
+are looking for a more verbose and comprehensive document, you should head to
+[Hadrian's README](../README.md).
+
## tl;dr
For GHC hackers already used to the Make build system, here is what you need to