summaryrefslogtreecommitdiff
path: root/hadrian/doc
diff options
context:
space:
mode:
authorXavier Denis <xldenis@gmail.com>2020-02-13 17:52:09 +0100
committerMarge Bot <ben+marge-bot@smart-cactus.org>2020-02-29 05:07:50 -0500
commita999ee96a22650b59855609f84e2808b4133e9e0 (patch)
treeaf6a76a019dab2f9b8d6428bedcf55d95d1e2e5e /hadrian/doc
parent99d2de860ff82e3f626c8b3d47d355ab16d18fd1 (diff)
downloadhaskell-a999ee96a22650b59855609f84e2808b4133e9e0.tar.gz
Rename ghci.sh and build.sh to ghci and build respectively
Convert hadrian buildscripts to unsuffixed, dashed form final cleanups
Diffstat (limited to 'hadrian/doc')
-rw-r--r--hadrian/doc/testsuite.md2
-rw-r--r--hadrian/doc/user-settings.md18
-rw-r--r--hadrian/doc/windows.md2
3 files changed, 11 insertions, 11 deletions
diff --git a/hadrian/doc/testsuite.md b/hadrian/doc/testsuite.md
index 65202dc038..ed1205ec0f 100644
--- a/hadrian/doc/testsuite.md
+++ b/hadrian/doc/testsuite.md
@@ -6,7 +6,7 @@ The simplest way to run the testsuite is
``` sh
# assuming 'build' is the build script you're using
-# (hadrian/build.sh, hadrian/build.bat, ...)
+# (hadrian/build, hadrian/build.bat, ...)
build test
```
diff --git a/hadrian/doc/user-settings.md b/hadrian/doc/user-settings.md
index de0d452fd5..9963bac5ed 100644
--- a/hadrian/doc/user-settings.md
+++ b/hadrian/doc/user-settings.md
@@ -106,7 +106,7 @@ userArgs = mconcat
You can match any combination of the `builder`, `stage`, `package`, `way`, `input`
and `output` predicates when specifying custom command line arguments. File
patterns such as `"**/Prelude.*"` can be used when matching input and output files,
-where `**` matches an arbitrary number of path components, but not absolute path
+where `**` matches an arbitrary number of path components, but not absolute path
prefixes, and `*` matches an entire path component, excluding any separators.
#### Enabling -Werror
@@ -368,7 +368,7 @@ the stage.
We could equivalently specify those settings on the command-line:
``` sh
-$ hadrian/build.sh "stage1.ghc-bin.ghc.link.opts += -eventlog" \
+$ hadrian/build "stage1.ghc-bin.ghc.link.opts += -eventlog" \
"*.base.ghc.*.opts += -v3"
```
@@ -388,7 +388,7 @@ the right names for them:
when building all known packages, if the Hadrian command ever gets them to be
built;
- the remaining slots specify the builder and how it was invoked,
-
+
* `ghc` refers to GHC commands; the final slot refers to how GHC is invoked:
* `c.opts` for commands that build C files with GHC
@@ -397,7 +397,7 @@ the right names for them:
* `deps.opts` for commands that figure out dependencies between Haskell modules
(with `ghc -M`)
* `toolargs.opts` for GHC commands that are used to generate the right ghci
- argument for `hadrian/ghci.sh` to work
+ argument for `hadrian/ghci` to work
* `cc` refers to C compiler commands
@@ -426,15 +426,15 @@ that takes an (optional) argument, `--complete-setting=<some string>`, and
prints on stdout all the setting keys that have the given string as a prefix.
There is a `hadrian/completion.sh` script that makes use of this rule to
-install Bash completions for `hadrian/build.sh` and `hadrian/build.cabal.sh`.
+install Bash completions for `hadrian/build` and `hadrian/build-cabal`.
You can try it out by doing:
``` sh
$ source hadrian/completion.sh
-$ hadrian/build.sh <TAB>
-$ hadrian/build.sh stage1.ba<TAB>
-$ hadrian/build.sh "stage1.base.ghc.<TAB>
-$ hadrian/build.sh "*.*.ghc.*.opts += -v3" "stage0.ghc-bin.ghc.lin<TAB>
+$ hadrian/build <TAB>
+$ hadrian/build stage1.ba<TAB>
+$ hadrian/build "stage1.base.ghc.<TAB>
+$ hadrian/build "*.*.ghc.*.opts += -v3" "stage0.ghc-bin.ghc.lin<TAB>
```
[split-sections]: https://downloads.haskell.org/~ghc/latest/docs/html/users_guide/phases.html#ghc-flag--split-sections
diff --git a/hadrian/doc/windows.md b/hadrian/doc/windows.md
index 9701b804f2..d8fc414f3a 100644
--- a/hadrian/doc/windows.md
+++ b/hadrian/doc/windows.md
@@ -38,7 +38,7 @@ but are much simpler and may also be more robust.
The `stack build` and `stack exec hadrian` commands can be replaced by an
invocation of Hadrian's Stack-based build script:
-`build.stack.bat -j --flavour=quickest`. Use this script if you plan to work on
+`build-stack.bat -j --flavour=quickest`. Use this script if you plan to work on
Hadrian and/or rebuild GHC often.
## Prerequisites