[commit: ghc] wip/alp/hadrian-docs-crosslinking: crosslink hadrian/README.md and hadrian/doc/make.md (47d62d0)

git at git.haskell.org git at git.haskell.org
Wed Jan 9 21:36:25 UTC 2019


Repository : ssh://git@git.haskell.org/ghc

On branch  : wip/alp/hadrian-docs-crosslinking
Link       : http://ghc.haskell.org/trac/ghc/changeset/47d62d041bc62a5820776633541da839e5f06947/ghc

>---------------------------------------------------------------

commit 47d62d041bc62a5820776633541da839e5f06947
Author: Alp Mestanogullari <alpmestan at gmail.com>
Date:   Wed Jan 9 12:51:50 2019 +0100

    crosslink hadrian/README.md and hadrian/doc/make.md


>---------------------------------------------------------------

47d62d041bc62a5820776633541da839e5f06947
 hadrian/README.md   | 9 +++++++--
 hadrian/doc/make.md | 6 ++++++
 2 files changed, 13 insertions(+), 2 deletions(-)

diff --git a/hadrian/README.md b/hadrian/README.md
index 16a26d0..f3d468c 100644
--- a/hadrian/README.md
+++ b/hadrian/README.md
@@ -12,8 +12,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
 ----------------
@@ -53,6 +51,13 @@ Stack (`build.stack.*`). Also see
 * 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 ca4828a..2a3b432 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



More information about the ghc-commits mailing list