summaryrefslogtreecommitdiff
path: root/docs/users_guide/using-warnings.rst
diff options
context:
space:
mode:
authorVladislav Zavialov <vlad.z.4096@gmail.com>2018-06-17 12:51:06 -0400
committerBen Gamari <ben@smart-cactus.org>2018-06-17 12:51:13 -0400
commit04e9fe5c7d3c2bac46933e3d647e561cb741edf4 (patch)
tree1e4f493c98e6df9abf4efafc0887c002bf632330 /docs/users_guide/using-warnings.rst
parent008ea12dd93b9f9104f0b532b278a31b719bafb8 (diff)
downloadhaskell-04e9fe5c7d3c2bac46933e3d647e561cb741edf4.tar.gz
Add -Werror=compat
Add a flag `-Werror=compat` to GHC which has the effect of `-Werror=x -Werror=y ...`, where `x, y, ...` are warnings from the `-Wcompat` option group. Test Plan: ./validate Reviewers: bgamari Reviewed By: bgamari Subscribers: rwbarton, thomie, carter GHC Trac Issues: #15278 Differential Revision: https://phabricator.haskell.org/D4860
Diffstat (limited to 'docs/users_guide/using-warnings.rst')
-rw-r--r--docs/users_guide/using-warnings.rst6
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/users_guide/using-warnings.rst b/docs/users_guide/using-warnings.rst
index 7dc4a3b048..510b56ad80 100644
--- a/docs/users_guide/using-warnings.rst
+++ b/docs/users_guide/using-warnings.rst
@@ -151,6 +151,9 @@ to abort.
Makes a specific warning into a fatal error. The warning will be enabled if
it hasn't been enabled yet.
+ ``-Werror=compat`` has the same effect as ``-Werror=...`` for each warning
+ flag in the :ghc-flag:`-Wcompat` option group.
+
.. ghc-flag:: -Wwarn
:shortdesc: make warnings non-fatal
:type: dynamic
@@ -172,6 +175,9 @@ to abort.
Note that it doesn't fully negate the effects of ``-Werror=<wflag>`` - the
warning will still be enabled.
+ ``-Wwarn=compat`` has the same effect as ``-Wwarn=...`` for each warning
+ flag in the :ghc-flag:`-Wcompat` option group.
+
When a warning is emitted, the specific warning flag which controls
it is shown.