diff options
| author | Ben Gamari <ben@well-typed.com> | 2021-09-08 21:02:27 +0000 |
|---|---|---|
| committer | Ben Gamari <ben@smart-cactus.org> | 2021-09-10 12:06:25 -0400 |
| commit | 13674e7958079d67825b8c9bf8eb0c5f00c04ee7 (patch) | |
| tree | cf658c48073388b0d0b1e4684a1753591a490051 | |
| parent | 87d93745fa14344a26ab242fd5db35e654e1da48 (diff) | |
| download | haskell-wip/hadrian-werror.tar.gz | |
hadrian: Recommend use of +werror over explicit flavour modificationwip/hadrian-werror
As noted in #20327, the previous guidance was out-of-date.
| -rw-r--r-- | hadrian/doc/user-settings.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/hadrian/doc/user-settings.md b/hadrian/doc/user-settings.md index 40b55db3a3..a15afa48b4 100644 --- a/hadrian/doc/user-settings.md +++ b/hadrian/doc/user-settings.md @@ -114,12 +114,12 @@ prefixes, and `*` matches an entire path component, excluding any separators. #### Enabling -Werror It is useful to enable `-Werror` when building GHC as this setting is -used in the CI to ensure a warning free build. The `werror` function can be -used to easily modify a flavour to turn this setting on. +used in the CI to ensure a warning-free build. The `+werror` +[flavour transformer](flavours.md#flavour-transformers) +can be used to easily modify a flavour to turn this setting on: ``` -devel2WerrorFlavour :: Flavour -devel2WerrorFlavour = werror (developmentFlavour Stage2) +hadrian/build --flavour=validate+werror ``` #### Linking GHC against the debugged RTS |