summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLuke Lau <luke_lau@icloud.com>2019-10-19 02:33:15 +0100
committerMarge Bot <ben+marge-bot@smart-cactus.org>2019-10-27 11:35:40 -0400
commit896d470a6872b5c36e57d4f068d81b2b14d34233 (patch)
tree262f5a33a29777d15dc6235251566eaabb6b8a06
parentd2520bef5e92d95142e7dfd7fd8ea61f8086aa19 (diff)
downloadhaskell-896d470a6872b5c36e57d4f068d81b2b14d34233.tar.gz
Add back documentation for deprecated -Whi-shadowing
This was removed in b538476be3706264620c072e6e436debf9e0d3e4, but without it the compare-flags.py script fails. This adds it back and marks it as deprecated, with a notice that it is slated for removal.
-rw-r--r--docs/users_guide/using-warnings.rst17
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/users_guide/using-warnings.rst b/docs/users_guide/using-warnings.rst
index cdc911befd..62b644aa8a 100644
--- a/docs/users_guide/using-warnings.rst
+++ b/docs/users_guide/using-warnings.rst
@@ -743,6 +743,23 @@ of ``-W(no-)*``.
This option is on by default.
+.. ghc-flag:: -Whi-shadowing
+ :shortdesc: *(deprecated)*
+ warn when a ``.hi`` file in the current directory shadows a library
+ :type: dynamic
+ :reverse: -Wno-hi-shadowing
+ :category:
+
+ .. index::
+ single: shadowing; interface files
+
+ Causes the compiler to emit a warning when a module or interface
+ file in the current directory is shadowing one with the same module
+ name in a library or other directory.
+
+ This flag was not implemented correctly and is now deprecated.
+ It will be removed in a later version of GHC.
+
.. ghc-flag:: -Widentities
:shortdesc: warn about uses of Prelude numeric conversions that are probably
the identity (and hence could be omitted)