summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAndrey Mokhov <andrey.mokhov@gmail.com>2017-11-15 21:58:18 +0000
committerAndrey Mokhov <andrey.mokhov@gmail.com>2017-11-15 21:58:18 +0000
commitc1fcd9b3f60e8420dd228cd4e3efeb9cfa793aa5 (patch)
treebb6feaa9e0b177cd58c460e7792ab70f00a19f05 /README.md
parent5229c43ccf77bcbffeced01dccb27398d017fa34 (diff)
downloadhaskell-c1fcd9b3f60e8420dd228cd4e3efeb9cfa793aa5.tar.gz
Squashed 'hadrian/' changes from 5ebb69a..fa3771f
fa3771f hadrian: Disable -Wno-undef in files which include ffi.h (#459) f15e851 Do not run configure by default (#458) 5baa8db Fix AppVeyor cache failure (#456) 94dbe9d Fix ghc-cabal build (#455) a679764 Fix CI scripts (#454) 06ec241 Widen bounds on Cabal (#452) git-subtree-dir: hadrian git-subtree-split: fa3771fe6baf5008a8506fec48220f8347ac59af
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 14 insertions, 14 deletions
diff --git a/README.md b/README.md
index eb3dd86be6..916edc21a1 100644
--- a/README.md
+++ b/README.md
@@ -31,9 +31,9 @@ hadrian/build.bat -j
```
Here flag `-j` enables parallelism and is optional. We will further refer to the build script
-simply as `build`. Note that Hadrian runs the `boot` and `configure` scripts automatically when
-needed. Use `--skip-configure` to suppress this behaviour (see the overview of command line
-flags below).
+simply as `build`. Note that Hadrian can also run the `boot` and `configure` scripts
+automatically if you pass the flag `--configure`, or simply `-c`. See the overview of
+command line flags below.
Notes:
@@ -55,6 +55,17 @@ are placed into `_build` and `inplace` directories.
In addition to standard Shake flags (try `--help`), the build system
currently supports several others:
+
+* `--configure` or `-c`: use this flag to run the `boot` and `configure` scripts
+automatically, so that you don't have to remember to run them manually as you normally
+do when using Make (typically only in the first build):
+ ```bash
+ ./boot
+ ./configure # On Windows run ./configure --enable-tarballs-autodownload
+ ```
+ Beware that with this flag Hadrian may do network I/O on Windows to download necessary
+ tarballs, which may sometimes be undesirable.
+
* `--flavour=FLAVOUR`: choose a build flavour. The following settings are currently supported:
`default`, `quick`, `quickest`, `perf`, `prof`, `devel1` and `devel2`. As an example, the
`quickest` flavour adds `-O0` flag to all GHC invocations and builds libraries only in the
@@ -79,17 +90,6 @@ colours).
settings: `none`, `brief` (one line per build command; this is the default setting),
`normal` (typically a box per build command), and `unicorn` (when `normal` just won't do).
-* `--skip-configure`: use this flag to suppress the default behaviour of Hadrian that
-runs the `boot` and `configure` scripts automatically when needed, so that you don't have
-to remember to run them manually. With `--skip-configure` you will need to manually run:
- ```bash
- ./boot
- ./configure # On Windows run ./configure --enable-tarballs-autodownload
- ```
- as you normally do when using `make`. Beware, by default Hadrian may do network I/O on
-Windows to download necessary tarballs, which may sometimes be undesirable; `--skip-configure`
-is your friend in such cases.
-
* `--split-objects`: generate split objects, which are switched off by default. Due to
a GHC [bug][ghc-split-objs-bug], you need a full clean rebuild when using this flag.