summaryrefslogtreecommitdiff
path: root/docs/users_guide/using-warnings.rst
diff options
context:
space:
mode:
authorHerbert Valerio Riedel <hvr@gnu.org>2016-02-27 23:36:11 +0100
committerHerbert Valerio Riedel <hvr@gnu.org>2016-02-27 23:45:35 +0100
commit46f3775c683faeb710c9dc22f360f39334947d73 (patch)
treec365cd820603f01c4b97392fe3824e014160d5a6 /docs/users_guide/using-warnings.rst
parent3cd4c9ca4564982cf159f11f59d434235ba28808 (diff)
downloadhaskell-46f3775c683faeb710c9dc22f360f39334947d73.tar.gz
Default to -fno-show-warning-groups (re #10752)
As `-fno-show-warning-groups` shows associated warning groups regardless of whether the respective warning group flag as been passed on the CLI, the warning-group information may be confusing to users. At this point, `-fshow-warning-groups` is useful mostly to GHC developers and possibly GHC users who want to see which warning groups an emitted warning is part of. (Btw, this is particularly interesting in combination with `-Weverything` which enables *every* warning flag known to GHC.) Consequently, starting with this commit, one has to opt-in via `-fshow-warning-groups` for GHC to show warning groups. In order to reduce the testsuite delta in this commit, the `-fshow-warning-groups` flag has been added to TEST_HC_OPTS.
Diffstat (limited to 'docs/users_guide/using-warnings.rst')
-rw-r--r--docs/users_guide/using-warnings.rst7
1 files changed, 4 insertions, 3 deletions
diff --git a/docs/users_guide/using-warnings.rst b/docs/users_guide/using-warnings.rst
index 3f24f6a6dc..ffe5a41fb0 100644
--- a/docs/users_guide/using-warnings.rst
+++ b/docs/users_guide/using-warnings.rst
@@ -103,13 +103,14 @@ The following flags are simple ways to select standard "packages" of warnings:
default, but can be useful to negate a :ghc-flag:`-Werror` flag.
When a warning is emitted, the specific warning flag which controls
-it, as well as the group it belongs to, are shown.
+it is shown.
.. ghc-flag:: -fshow-warning-groups
- Name the group a warning flag belongs to.
+ When showing which flag controls a warning, also show the
+ respective warning group flag(s) that warning is contained in.
- This is enabled by default. Disable with ``-fno-show-warning-groups``.
+ This option is off by default.
The full set of warning options is described below. To turn off any
warning, simply give the corresponding ``-Wno-...`` option on the