summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorVladislav Zavialov <vlad.z.4096@gmail.com>2018-10-12 11:15:26 -0400
committerBen Gamari <ben@smart-cactus.org>2018-10-12 11:51:46 -0400
commit5b2388b2cb657771c3c578eaf552b300b79f8260 (patch)
tree4ceb57f268be39dbec227413666a5f7601f9fdb0 /docs
parent05b2587b00d0a69ae98b2c4976b85cc3e33a7b49 (diff)
downloadhaskell-5b2388b2cb657771c3c578eaf552b300b79f8260.tar.gz
Include -fwarn-star-is-type in -Wcompat
According to the deprecation schedule in the accepted proposal, the first step is to include `-fwarn-star-is-type` in `-Wcompat`. Test Plan: Validate Reviewers: bgamari Reviewed By: bgamari Subscribers: rwbarton, carter GHC Trac Issues: #15476 Differential Revision: https://phabricator.haskell.org/D5044
Diffstat (limited to 'docs')
-rw-r--r--docs/users_guide/8.8.1-notes.rst2
-rw-r--r--docs/users_guide/using-warnings.rst4
2 files changed, 6 insertions, 0 deletions
diff --git a/docs/users_guide/8.8.1-notes.rst b/docs/users_guide/8.8.1-notes.rst
index a27aee721e..d3da37e9eb 100644
--- a/docs/users_guide/8.8.1-notes.rst
+++ b/docs/users_guide/8.8.1-notes.rst
@@ -59,6 +59,8 @@ Compiler
- New :ghc-flag:`-keep-hscpp-files` to keep the output of the CPP pre-processor.
+- The :ghc-flag:`-Wcompat` warning group now includes :ghc-flag:`-Wstar-is-type`.
+
Runtime system
~~~~~~~~~~~~~~
diff --git a/docs/users_guide/using-warnings.rst b/docs/users_guide/using-warnings.rst
index dba30dbf1e..aeabbe9713 100644
--- a/docs/users_guide/using-warnings.rst
+++ b/docs/users_guide/using-warnings.rst
@@ -117,6 +117,7 @@ The following flags are simple ways to select standard "packages" of warnings:
* :ghc-flag:`-Wsemigroup`
* :ghc-flag:`-Wnoncanonical-monoid-instances`
* :ghc-flag:`-Wimplicit-kind-vars`
+ * :ghc-flag:`-Wstar-is-type`
.. ghc-flag:: -Wno-compat
:shortdesc: Disables all warnings enabled by :ghc-flag:`-Wcompat`.
@@ -1194,6 +1195,9 @@ of ``-W(no-)*``.
breaking change takes place. The recommended fix is to replace ``*`` with
``Type`` imported from ``Data.Kind``.
+ Being part of the :ghc-flag:`-Wcompat` option group, this warning is off by
+ default, but will be switched on in a future GHC release.
+
.. ghc-flag:: -Wstar-binder
:shortdesc: warn about binding the ``(*)`` type operator despite
:ghc-flag:`-XStarIsType`