summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBen Gamari <ben@well-typed.com>2020-09-30 22:31:55 -0400
committerBen Gamari <ben@well-typed.com>2020-09-30 22:31:55 -0400
commit5c32655fffd0d8862f3ba693351f1e612daa0b6b (patch)
treea19036f52d6c778106d100f158b6e035d72a1df7
parent235e410f63a4725bbc4466dbdef7d5f661793e84 (diff)
downloadhaskell-5c32655fffd0d8862f3ba693351f1e612daa0b6b.tar.gz
hadrian/doc: Clarify documentation of key-value configuration
-rw-r--r--hadrian/doc/user-settings.md3
1 files changed, 2 insertions, 1 deletions
diff --git a/hadrian/doc/user-settings.md b/hadrian/doc/user-settings.md
index ada2b98760..e6146d8ea4 100644
--- a/hadrian/doc/user-settings.md
+++ b/hadrian/doc/user-settings.md
@@ -382,7 +382,8 @@ the right names for them:
- the stage slot, which comes first, can be filled with any of `stage0`,
`stage1`, `stage2`, `stage3` or `*`; any value but `*` will restrict the
setting update to targets built during the given stage, while `*` is taken
- to mean "for any stage".
+ to mean "for any stage". For instance, the above example will affect
+ the linking of the `_build/stage1/bin/ghc` executable.
- the package slot, which comes second, can be filled with any package name
that Hadrian knows about (all packages that are part of a GHC checkout),
or `*`, to respectively mean that the builder options are going to be updated