summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndrey Mokhov <andrey.mokhov@gmail.com>2021-12-11 23:48:24 +0000
committerMarge Bot <ben+marge-bot@smart-cactus.org>2021-12-12 09:11:20 -0500
commit93783e6a8765e1410d0a14fd5249a995c6759308 (patch)
treee6d85781f873b0df6866491e3da5e64502d8ac5e
parentf04d1a4935beda0144a7b830589ab214d785d592 (diff)
downloadhaskell-93783e6a8765e1410d0a14fd5249a995c6759308.tar.gz
Drop --configure from Hadrian docs
-rw-r--r--hadrian/README.md25
-rw-r--r--hadrian/doc/make.md4
-rw-r--r--hadrian/doc/windows.md3
3 files changed, 4 insertions, 28 deletions
diff --git a/hadrian/README.md b/hadrian/README.md
index 20020c3b92..a815039e7f 100644
--- a/hadrian/README.md
+++ b/hadrian/README.md
@@ -32,9 +32,7 @@ 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 can also run the `boot` and
-`configure` scripts automatically for you if you pass the flag `--configure`,
-or simply `-c`. See the overview of command line flags below.
+build script simply as `build`.
Notes:
@@ -78,16 +76,6 @@ for GHC developers who want to build GHC in different ways or at different
commits, from the same source directory, and have the build products sit in
different, isolated folders.
-* `--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
@@ -227,7 +215,7 @@ you can tell hadrian to build the compiler and also run the linters:
* `build clean` removes all build artefacts.
* `build distclean` additionally remove the mingw tarballs and fs* files created
- by configure.
+ by `configure`.
* `build -B` forces Shake to rerun all rules, even if the previous build results
are still up-to-date.
@@ -339,15 +327,6 @@ Troubleshooting
Here are a few simple suggestions that might help you fix the build:
-* If Hadrian fails with the message
- `Configuration file hadrian/cfg/system.config is missing`, you have probably
- forgotten to pass the `--configure` flag during the first build.
-
-* With the `--configure` (`-c`) flag, Hadrian sometimes fetches a wrong
- Happy saying something like: `HappyTemplate-arrays-coerce: openFile: does not exist`
- (as mentioned [here](https://github.com/haskell/cabal/issues/5867)), in
- which case you might be better off running `./configure` manually before Hadrian.
-
* The call to `build test` sometimes fails with
`libCffi_p.a: copyFile: does not exist` (as noticed
[here](https://gitlab.haskell.org/ghc/ghc/issues/15877#note_166739)).
diff --git a/hadrian/doc/make.md b/hadrian/doc/make.md
index 6d20d42503..82e5ab7929 100644
--- a/hadrian/doc/make.md
+++ b/hadrian/doc/make.md
@@ -11,11 +11,9 @@ are looking for a more verbose and comprehensive document, you should head to
For GHC hackers already used to the Make build system, here is what you need to
know:
-- You can still boot and configure yourself.
+- You still need to `boot` and `configure` yourself.
- Use `hadrian/build.{sh, bat}` instead of `make`. It supports `-j`. This build
script will from now on be referred to as simply `build`.
-- Add the `-c` flag if you want hadrian to boot and configure the source tree
- for you.
- Build products are not in `inplace` anymore, but `_build` by default. Your
stage 2 GHC would then be at `_build/stage1/bin/ghc` (because it's built by
the stage 1 compiler).
diff --git a/hadrian/doc/windows.md b/hadrian/doc/windows.md
index d8fc414f3a..213bcc86c8 100644
--- a/hadrian/doc/windows.md
+++ b/hadrian/doc/windows.md
@@ -20,8 +20,7 @@ stack exec -- pacman -S autoconf automake-wrapper make patch python tar --noconf
stack build
# Build GHC
-# Note that the --configure flag is required only for the first build
-stack exec hadrian -- --directory ".." -j --flavour=quickest --configure
+stack exec hadrian -- --directory ".." -j --flavour=quickest
# Test GHC
cd ..