[commit: ghc] wip/nfs-locking: Update README.md (79ceb45)
git at git.haskell.org
git at git.haskell.org
Thu Oct 26 23:50:59 UTC 2017
Repository : ssh://git@git.haskell.org/ghc
On branch : wip/nfs-locking
Link : http://ghc.haskell.org/trac/ghc/changeset/79ceb456ffb5511e630ace24ed409782119ddf5d/ghc
>---------------------------------------------------------------
commit 79ceb456ffb5511e630ace24ed409782119ddf5d
Author: Moritz Angermann <moritz.angermann at gmail.com>
Date: Fri Jan 1 01:20:06 2016 +0800
Update README.md
Roll Linux / OS X into one section. This should fix #37.
>---------------------------------------------------------------
79ceb456ffb5511e630ace24ed409782119ddf5d
README.md | 29 +++++++++++------------------
1 file changed, 11 insertions(+), 18 deletions(-)
diff --git a/README.md b/README.md
index 93674a1..f26cc49 100644
--- a/README.md
+++ b/README.md
@@ -14,7 +14,13 @@ This is supposed to go into the `shake-build` directory of the GHC source tree.
Trying it
---------
-### Linux
+Please see the [Preparation][ghc-preparation] on the haskell wiki
+for general preparation. The preparation steps for the `shake` build system are
+identical to those for the `make` build system. This means that you don't need
+to adjust anything if you are already familiar with building ghc using the `make`
+build system.
+
+### Linux / Mac OS X
```bash
git clone git://git.haskell.org/ghc
@@ -23,6 +29,9 @@ git submodule update --init
git clone git://github.com/snowleopard/shaking-up-ghc shake-build
./boot
./configure
+# or if you want to use clang (e.g. building on OS X)
+./configure --with-gcc=$(which clang) # See #26
+
```
Now you have a couple of options:
@@ -46,20 +55,6 @@ shake-build/build.bat
```
Also see the [Building GHC on Windows guide][ghc-windows-building-guide].
-### Mac OS X
-
-```bash
-git clone git://git.haskell.org/ghc
-cd ghc
-git submodule update --init
-git clone git://github.com/snowleopard/shaking-up-ghc shake-build
-./boot
-./configure --with-gcc=$(which clang) # See #26
-./shake-build/build.sh
-```
-
-See the Linux section for running in a Cabal sandbox.
-
### Resetting the build
To reset the new build system run the build script with `-B` flag. This will force Shake to rerun all rules, even if the results of the previous build are still in the GHC tree. This is a temporary solution; we are working on a proper reset functionality (see [#32](https://github.com/snowleopard/shaking-up-ghc/issues/32)).
@@ -76,10 +71,8 @@ documentation is currently non-existent, but we will start addressing this
once the codebase stabilises.
-
-
-
[ghc-shake-wiki]: https://ghc.haskell.org/trac/ghc/wiki/Building/Shake
+[ghc-preparation]: https://ghc.haskell.org/trac/ghc/wiki/Building/Preparation
[ghc-windows-building-guide]: https://ghc.haskell.org/trac/ghc/wiki/Building/Preparation/Windows
[ghc]: https://en.wikipedia.org/wiki/Glasgow_Haskell_Compiler
[shake-blog-post]: https://blogs.ncl.ac.uk/andreymokhov/shaking-up-ghc
More information about the ghc-commits
mailing list