testsuite: Assert that testsuite ways are known
[ghc.git] / docs / users_guide / using-warnings.rst
1 .. _options-sanity:
2
3 Warnings and sanity-checking
4 ----------------------------
5
6 .. index::
7    single: sanity-checking options
8    single: warnings
9
10 GHC has a number of options that select which types of non-fatal error
11 messages, otherwise known as warnings, can be generated during compilation.
12 Some options control individual warnings and others control collections
13 of warnings.
14 To turn off an individual warning ``-W<wflag>``, use ``-Wno-<wflag>``.
15 To reverse ``-Werror``, which makes all warnings into errors, use ``-Wwarn``.
16
17 By default, you get a standard set of warnings which are
18 generally likely to indicate bugs in your program. These are:
19
20 .. hlist::
21     :columns: 3
22
23     * :ghc-flag:`-Woverlapping-patterns`
24     * :ghc-flag:`-Wwarnings-deprecations`
25     * :ghc-flag:`-Wdeprecations`
26     * :ghc-flag:`-Wdeprecated-flags`
27     * :ghc-flag:`-Wunrecognised-pragmas`
28     * :ghc-flag:`-Wduplicate-exports`
29     * :ghc-flag:`-Wderiving-defaults`
30     * :ghc-flag:`-Woverflowed-literals`
31     * :ghc-flag:`-Wempty-enumerations`
32     * :ghc-flag:`-Wmissing-fields`
33     * :ghc-flag:`-Wmissing-methods`
34     * :ghc-flag:`-Wwrong-do-bind`
35     * :ghc-flag:`-Wsimplifiable-class-constraints`
36     * :ghc-flag:`-Wtyped-holes`
37     * :ghc-flag:`-Wdeferred-type-errors`
38     * :ghc-flag:`-Wpartial-type-signatures`
39     * :ghc-flag:`-Wunsupported-calling-conventions`
40     * :ghc-flag:`-Wdodgy-foreign-imports`
41     * :ghc-flag:`-Winline-rule-shadowing`
42     * :ghc-flag:`-Wunsupported-llvm-version`
43     * :ghc-flag:`-Wmissed-extra-shared-lib`
44     * :ghc-flag:`-Wtabs`
45     * :ghc-flag:`-Wunrecognised-warning-flags`
46     * :ghc-flag:`-Winaccessible-code`
47     * :ghc-flag:`-Wstar-is-type`
48     * :ghc-flag:`-Wstar-binder`
49     * :ghc-flag:`-Wspace-after-bang`
50
51 The following flags are simple ways to select standard "packages" of warnings:
52
53 .. ghc-flag:: -W
54     :shortdesc: enable normal warnings
55     :type: dynamic
56     :reverse: -w
57     :category:
58
59     Provides the standard warnings plus
60
61     .. hlist::
62         :columns: 3
63
64         * :ghc-flag:`-Wunused-binds`
65         * :ghc-flag:`-Wunused-matches`
66         * :ghc-flag:`-Wunused-foralls`
67         * :ghc-flag:`-Wunused-imports`
68         * :ghc-flag:`-Wincomplete-patterns`
69         * :ghc-flag:`-Wdodgy-exports`
70         * :ghc-flag:`-Wdodgy-imports`
71         * :ghc-flag:`-Wunbanged-strict-patterns`
72
73 .. ghc-flag:: -Wall
74     :shortdesc: enable almost all warnings (details in :ref:`options-sanity`)
75     :type: dynamic
76     :reverse: -w
77     :category:
78
79     Turns on all warning options that indicate potentially suspicious
80     code. The warnings that are *not* enabled by :ghc-flag:`-Wall` are
81
82     .. hlist::
83         :columns: 3
84
85         * :ghc-flag:`-Wincomplete-uni-patterns`
86         * :ghc-flag:`-Wincomplete-record-updates`
87         * :ghc-flag:`-Wmonomorphism-restriction`
88         * :ghc-flag:`-Wimplicit-prelude`
89         * :ghc-flag:`-Wmissing-local-signatures`
90         * :ghc-flag:`-Wmissing-exported-signatures`
91         * :ghc-flag:`-Wmissing-export-lists`
92         * :ghc-flag:`-Wmissing-import-lists`
93         * :ghc-flag:`-Wmissing-home-modules`
94         * :ghc-flag:`-Widentities`
95         * :ghc-flag:`-Wredundant-constraints`
96         * :ghc-flag:`-Wpartial-fields`
97         * :ghc-flag:`-Wmissed-specialisations`
98         * :ghc-flag:`-Wall-missed-specialisations`
99
100 .. ghc-flag:: -Weverything
101     :shortdesc: enable all warnings supported by GHC
102     :type: dynamic
103     :category:
104
105     Turns on every single warning supported by the compiler.
106
107 .. ghc-flag:: -Wcompat
108     :shortdesc: enable future compatibility warnings
109         (details in :ref:`options-sanity`)
110     :type: dynamic
111     :reverse: -Wno-compat
112     :category:
113
114     Turns on warnings that will be enabled by default in the future, but remain
115     off in normal compilations for the time being. This allows library authors
116     eager to make their code future compatible to adapt to new features before
117     they even generate warnings.
118
119     This currently enables
120
121     .. hlist::
122         :columns: 3
123
124         * :ghc-flag:`-Wmissing-monadfail-instances`
125         * :ghc-flag:`-Wsemigroup`
126         * :ghc-flag:`-Wnoncanonical-monoid-instances`
127         * :ghc-flag:`-Wstar-is-type`
128
129 .. ghc-flag:: -Wno-compat
130     :shortdesc: Disables all warnings enabled by :ghc-flag:`-Wcompat`.
131     :type: dynamic
132     :reverse: -Wcompat
133     :category:
134
135     Disables all warnings enabled by :ghc-flag:`-Wcompat`.
136
137 .. ghc-flag:: -w
138     :shortdesc: disable all warnings
139     :type: dynamic
140     :category:
141
142     Turns off all warnings, including the standard ones and those that
143     :ghc-flag:`-Wall` doesn't enable.
144
145 These options control which warnings are considered fatal and cause compilation
146 to abort.
147
148 .. ghc-flag:: -Werror
149     :shortdesc: make warnings fatal
150     :type: dynamic
151     :reverse: -Wwarn
152     :category:
153
154     Makes any warning into a fatal error. Useful so that you don't miss
155     warnings when doing batch compilation. To reverse ``-Werror`` and stop
156     treating any warnings as errors use ``-Wwarn``, or use ``-Wwarn=<wflag>``
157     to stop treating specific warnings as errors.
158
159 .. ghc-flag:: -Werror=⟨wflag⟩
160     :shortdesc: make a specific warning fatal
161     :type: dynamic
162     :reverse: -Wwarn=⟨wflag⟩
163     :category:
164     :noindex:
165
166     :implies: ``-W<wflag>``
167
168     Makes a specific warning into a fatal error. The warning will be enabled if
169     it hasn't been enabled yet. Can be reversed with ``-Wwarn=<wflag>``.
170
171     ``-Werror=compat`` has the same effect as ``-Werror=...`` for each warning
172     flag in the :ghc-flag:`-Wcompat` option group.
173
174 .. ghc-flag:: -Wwarn
175     :shortdesc: make warnings non-fatal
176     :type: dynamic
177     :reverse: -Werror
178     :category:
179
180     Warnings are treated only as warnings, not as errors. This is the
181     default, but can be useful to negate a :ghc-flag:`-Werror` flag.
182
183 .. ghc-flag:: -Wwarn=⟨wflag⟩
184     :shortdesc: make a specific warning non-fatal
185     :type: dynamic
186     :reverse: -Werror=⟨wflag⟩
187     :category:
188     :noindex:
189
190     Causes a specific warning to be treated as normal warning, not fatal error.
191
192     Note that it doesn't fully negate the effects of ``-Werror=<wflag>`` - the
193     warning will still be enabled.
194
195     ``-Wwarn=compat`` has the same effect as ``-Wwarn=...`` for each warning
196     flag in the :ghc-flag:`-Wcompat` option group.
197
198 When a warning is emitted, the specific warning flag which controls
199 it is shown.
200
201 .. ghc-flag:: -fshow-warning-groups
202     :shortdesc: show which group an emitted warning belongs to.
203     :type: dynamic
204     :reverse: -fno-show-warning-groups
205     :category:
206
207     When showing which flag controls a warning, also show the
208     respective warning group flag(s) that warning is contained in.
209
210     This option is off by default.
211
212 The full set of warning options is described below. To turn off any
213 warning, simply give the corresponding ``-Wno-...`` option on the
214 command line. For backwards compatibility with GHC versions prior to 8.0,
215 all these warnings can still be controlled with ``-f(no-)warn-*`` instead
216 of ``-W(no-)*``.
217
218 .. ghc-flag:: -Wunrecognised-warning-flags
219     :shortdesc: throw a warning when an unrecognised ``-W...`` flag is
220         encountered on the command line.
221     :type: dynamic
222     :reverse: -Wno-unrecognised-warning-flags
223     :category:
224
225     Enables warnings when the compiler encounters a ``-W...`` flag that is not
226     recognised.
227
228     This warning is on by default.
229
230 .. ghc-flag:: -Wtyped-holes
231     :shortdesc: Report warnings when :ref:`typed hole <typed-holes>` errors are
232         :ref:`deferred until runtime <defer-type-errors>`. See
233         :ghc-flag:`-fdefer-typed-holes`.
234     :type: dynamic
235     :reverse: -Wno-typed-holes
236     :category:
237
238     Determines whether the compiler reports typed holes warnings. Has no
239     effect unless typed holes errors are deferred until runtime. See
240     :ref:`typed-holes` and :ref:`defer-type-errors`
241
242     This warning is on by default.
243
244 .. ghc-flag:: -Wdeferred-type-errors
245     :shortdesc: Report warnings when :ref:`deferred type errors
246         <defer-type-errors>` are enabled. This option is enabled by
247         default. See :ghc-flag:`-fdefer-type-errors`.
248     :type: dynamic
249     :reverse: -Wno-deferred-type-errors
250     :category:
251
252     Causes a warning to be reported when a type error is deferred until
253     runtime. See :ref:`defer-type-errors`
254
255     This warning is on by default.
256
257 .. ghc-flag:: -fdefer-type-errors
258     :shortdesc: Turn type errors into warnings, :ref:`deferring the error until
259         runtime <defer-type-errors>`. Implies
260         :ghc-flag:`-fdefer-typed-holes` and
261         :ghc-flag:`-fdefer-out-of-scope-variables`.
262         See also :ghc-flag:`-Wdeferred-type-errors`
263     :type: dynamic
264     :reverse: -fno-defer-type-errors
265     :category:
266
267     :implies: :ghc-flag:`-fdefer-typed-holes`, :ghc-flag:`-fdefer-out-of-scope-variables`
268
269     Defer as many type errors as possible until runtime. At compile time
270     you get a warning (instead of an error). At runtime, if you use a
271     value that depends on a type error, you get a runtime error; but you
272     can run any type-correct parts of your code just fine. See
273     :ref:`defer-type-errors`
274
275 .. ghc-flag:: -fdefer-typed-holes
276     :shortdesc: Convert :ref:`typed hole <typed-holes>` errors into warnings,
277         :ref:`deferring the error until runtime <defer-type-errors>`.
278         Implied by :ghc-flag:`-fdefer-type-errors`.
279         See also :ghc-flag:`-Wtyped-holes`.
280     :type: dynamic
281     :reverse: -fno-defer-typed-holes
282     :category:
283
284     Defer typed holes errors (errors about names with a leading underscore
285     (e.g., “_”, “_foo”, “_bar”)) until runtime. This will turn the errors
286     produced by :ref:`typed holes <typed-holes>` into warnings. Using a value
287     that depends on a typed hole produces a runtime error, the same as
288     :ghc-flag:`-fdefer-type-errors` (which implies this option). See :ref:`typed-holes`
289     and :ref:`defer-type-errors`.
290
291     Implied by :ghc-flag:`-fdefer-type-errors`. See also :ghc-flag:`-Wtyped-holes`.
292
293 .. ghc-flag:: -fdefer-out-of-scope-variables
294     :shortdesc: Convert variable out of scope variables errors into warnings.
295         Implied by :ghc-flag:`-fdefer-type-errors`.
296         See also :ghc-flag:`-Wdeferred-out-of-scope-variables`.
297     :type: dynamic
298     :reverse: -fno-defer-out-of-scope-variables
299     :category:
300
301     Defer variable out-of-scope errors (errors about names without a leading underscore)
302     until runtime. This will turn variable-out-of-scope errors into warnings.
303     Using a value that depends on an out-of-scope variable produces a runtime error,
304     the same as :ghc-flag:`-fdefer-type-errors` (which implies this option).
305     See :ref:`typed-holes` and :ref:`defer-type-errors`.
306
307     Implied by :ghc-flag:`-fdefer-type-errors`. See also :ghc-flag:`-Wdeferred-out-of-scope-variables`.
308
309 .. ghc-flag:: -Wdeferred-out-of-scope-variables
310     :shortdesc: Report warnings when variable out-of-scope errors are
311         :ref:`deferred until runtime <defer-type-errors>`.
312         See :ghc-flag:`-fdefer-out-of-scope-variables`.
313     :type: dynamic
314     :reverse: -Wno-deferred-out-of-scope-variables
315     :category:
316
317     Warn when a deferred out-of-scope variable is encountered.
318
319 .. ghc-flag:: -Wpartial-type-signatures
320     :shortdesc: warn about holes in partial type signatures when
321         :extension:`PartialTypeSignatures` is enabled. Not applicable when
322         :extension:`PartialTypeSignatures` is not enabled, in which case
323         errors are generated for such holes.
324     :type: dynamic
325     :reverse: -Wno-partial-type-signatures
326     :category:
327
328     Determines whether the compiler reports holes in partial type
329     signatures as warnings. Has no effect unless
330     :extension:`PartialTypeSignatures` is enabled, which controls whether
331     errors should be generated for holes in types or not. See
332     :ref:`partial-type-signatures`.
333
334     This warning is on by default.
335
336 .. ghc-flag:: -fhelpful-errors
337     :shortdesc: Make suggestions for mis-spelled names.
338     :type: dynamic
339     :reverse: -fno-helpful-errors
340     :category:
341
342     When a name or package is not found in scope, make suggestions for
343     the name or package you might have meant instead.
344
345     This option is on by default.
346
347 .. ghc-flag:: -Wunrecognised-pragmas
348     :shortdesc: warn about uses of pragmas that GHC doesn't recognise
349     :type: dynamic
350     :reverse: -Wno-unrecognised-pragmas
351     :category:
352
353     Causes a warning to be emitted when a pragma that GHC doesn't
354     recognise is used. As well as pragmas that GHC itself uses, GHC also
355     recognises pragmas known to be used by other tools, e.g.
356     ``OPTIONS_HUGS`` and ``DERIVE``.
357
358     This option is on by default.
359
360 .. ghc-flag:: -Wmissed-specialisations
361     :shortdesc: warn when specialisation of an imported, overloaded function
362         fails.
363     :type: dynamic
364     :reverse: -Wno-missed-specialisations
365     :category:
366
367     Emits a warning if GHC cannot specialise an overloaded function, usually
368     because the function needs an ``INLINABLE`` pragma. Reports when the
369     situation arises during specialisation of an imported function.
370
371     This form is intended to catch cases where an imported function
372     that is marked as ``INLINABLE`` (presumably to enable specialisation)
373     cannot be specialised as it calls other functions that are themselves not
374     specialised.
375
376     Note that this warning will not throw errors if used with
377     :ghc-flag:`-Werror`.
378
379     This option is off by default.
380
381 .. ghc-flag:: -Wall-missed-specialisations
382     :shortdesc: warn when specialisation of any overloaded function fails.
383     :type: dynamic
384     :reverse: -Wno-all-missed-specialisations
385     :category:
386
387     Emits a warning if GHC cannot specialise an overloaded function, usually
388     because the function needs an ``INLINABLE`` pragma. Reports
389     all such situations.
390
391     Note that this warning will not throw errors if used with
392     :ghc-flag:`-Werror`.
393
394     This option is off by default.
395
396 .. ghc-flag:: -Wwarnings-deprecations
397     :shortdesc: warn about uses of functions & types that have warnings or
398         deprecated pragmas
399     :type: dynamic
400     :reverse: -Wno-warnings-deprecations
401     :category:
402
403     .. index::
404        pair: deprecations; warnings
405
406     Causes a warning to be emitted when a module, function or type with
407     a ``WARNING`` or ``DEPRECATED pragma`` is used. See
408     :ref:`warning-deprecated-pragma` for more details on the pragmas.
409
410     This option is on by default.
411
412 .. ghc-flag:: -Wdeprecations
413     :shortdesc: warn about uses of functions & types that have warnings or
414         deprecated pragmas. Alias for :ghc-flag:`-Wwarnings-deprecations`
415     :type: dynamic
416     :reverse: -Wno-deprecations
417     :category:
418
419     .. index::
420        single: deprecations
421
422     Causes a warning to be emitted when a module, function or type with
423     a ``WARNING`` or ``DEPRECATED pragma`` is used. See
424     :ref:`warning-deprecated-pragma` for more details on the pragmas.
425     An alias for :ghc-flag:`-Wwarnings-deprecations`.
426
427     This option is on by default.
428
429 .. ghc-flag:: -Wnoncanonical-monad-instances
430     :shortdesc: warn when ``Applicative`` or ``Monad`` instances have
431         noncanonical definitions of ``return``, ``pure``, ``(>>)``,
432         or ``(*>)``.
433         See flag description in :ref:`options-sanity` for more details.
434     :type: dynamic
435     :reverse: -Wno-noncanonical-monad-instances
436     :category:
437
438     Warn if noncanonical ``Applicative`` or ``Monad`` instances
439     declarations are detected.
440
441     When this warning is enabled, the following conditions are verified:
442
443     In ``Monad`` instances declarations warn if any of the following
444     conditions does not hold:
445
446      * If ``return`` is defined it must be canonical (i.e. ``return = pure``).
447      * If ``(>>)`` is defined it must be canonical (i.e. ``(>>) = (*>)``).
448
449     Moreover, in ``Applicative`` instance declarations:
450
451      * Warn if ``pure`` is defined backwards (i.e. ``pure = return``).
452      * Warn if ``(*>)`` is defined backwards (i.e. ``(*>) = (>>)``).
453
454     This option is off by default.
455
456 .. ghc-flag:: -Wnoncanonical-monadfail-instances
457     :shortdesc: warn when ``Monad`` or ``MonadFail`` instances have
458         noncanonical definitions of ``fail``.
459         See flag description in :ref:`options-sanity` for more details.
460     :type: dynamic
461     :reverse: -Wno-noncanonical-monadfail-instances
462     :category:
463
464     Warn if noncanonical ``Monad`` or ``MonadFail`` instances
465     declarations are detected.
466
467     When this warning is enabled, the following conditions are verified:
468
469     In ``Monad`` instances declarations warn if any of the following
470     conditions does not hold:
471
472      * If ``fail`` is defined it must be canonical
473        (i.e. ``fail = Control.Monad.Fail.fail``).
474
475     Moreover, in ``MonadFail`` instance declarations:
476
477      * Warn if ``fail`` is defined backwards
478        (i.e. ``fail = Control.Monad.fail``).
479
480     See also :ghc-flag:`-Wmissing-monadfail-instances`.
481
482     This option is off by default.
483
484 .. ghc-flag:: -Wnoncanonical-monoid-instances
485     :shortdesc: warn when ``Semigroup`` or ``Monoid`` instances have
486         noncanonical definitions of ``(<>)`` or ``mappend``.
487         See flag description in :ref:`options-sanity` for more details.
488     :type: dynamic
489     :reverse: -Wno-noncanonical-monoid-instances
490     :category:
491
492     Warn if noncanonical ``Semigroup`` or ``Monoid`` instances
493     declarations are detected.
494
495     When this warning is enabled, the following conditions are verified:
496
497     In ``Monoid`` instances declarations warn if any of the following
498     conditions does not hold:
499
500      * If ``mappend`` is defined it must be canonical
501        (i.e. ``mappend = (Data.Semigroup.<>)``).
502
503     Moreover, in ``Semigroup`` instance declarations:
504
505      * Warn if ``(<>)`` is defined backwards (i.e. ``(<>) = mappend``).
506
507     This warning is off by default. However, it is part of the
508     :ghc-flag:`-Wcompat` option group.
509
510 .. ghc-flag:: -Wmissing-monadfail-instances
511     :shortdesc: Warn when a failable pattern is used in a do-block that does
512         not have a ``MonadFail`` instance.
513     :type: dynamic
514     :reverse: -Wno-missing-monadfail-instances
515     :category:
516
517     .. index::
518        single: MFP
519        single: MonadFail Proposal
520
521     Warn when a failable pattern is used in a do-block that does not have a
522     ``MonadFail`` instance.
523
524     See also :ghc-flag:`-Wnoncanonical-monadfail-instances`.
525
526     Being part of the :ghc-flag:`-Wcompat` option group, this warning is off by
527     default, but will be switched on in a future GHC release, as part of
528     the `MonadFail Proposal (MFP)
529     <https://prime.haskell.org/wiki/Libraries/Proposals/MonadFail>`__.
530
531 .. ghc-flag:: -Wsemigroup
532     :shortdesc: warn when a ``Monoid`` is not ``Semigroup``, and on non-
533         ``Semigroup`` definitions of ``(<>)``?
534     :type: dynamic
535     :reverse: -Wno-semigroup
536     :category:
537
538     .. index::
539        single: semigroup; warning
540
541     Warn when definitions are in conflict with the future inclusion of
542     ``Semigroup`` into the standard typeclasses.
543
544      1. Instances of ``Monoid`` should also be instances of ``Semigroup``
545      2. The ``Semigroup`` operator ``(<>)`` will be in ``Prelude``, which
546         clashes with custom local definitions of such an operator
547
548     Being part of the :ghc-flag:`-Wcompat` option group, this warning is off by
549     default, but will be switched on in a future GHC release.
550
551 .. ghc-flag:: -Wdeprecated-flags
552     :shortdesc: warn about uses of commandline flags that are deprecated
553     :type: dynamic
554     :reverse: -Wno-deprecated-flags
555     :category:
556
557     .. index::
558        single: deprecated flags
559
560     Causes a warning to be emitted when a deprecated command-line flag
561     is used.
562
563     This option is on by default.
564
565 .. ghc-flag:: -Wunsupported-calling-conventions
566     :shortdesc: warn about use of an unsupported calling convention
567     :type: dynamic
568     :reverse: -Wno-unsupported-calling-conventions
569     :category:
570
571     Causes a warning to be emitted for foreign declarations that use
572     unsupported calling conventions. In particular, if the ``stdcall``
573     calling convention is used on an architecture other than i386 then
574     it will be treated as ``ccall``.
575
576 .. ghc-flag:: -Wdodgy-foreign-imports
577     :shortdesc: warn about dodgy foreign imports
578     :type: dynamic
579     :reverse: -Wno-dodgy-foreign-import
580     :category:
581
582     Causes a warning to be emitted for foreign imports of the following
583     form: ::
584
585         foreign import "f" f :: FunPtr t
586
587     on the grounds that it probably should be ::
588
589         foreign import "&f" f :: FunPtr t
590
591     The first form declares that ``f`` is a (pure) C function that takes
592     no arguments and returns a pointer to a C function with type ``t``,
593     whereas the second form declares that ``f`` itself is a C function
594     with type ``t``. The first declaration is usually a mistake, and one
595     that is hard to debug because it results in a crash, hence this
596     warning.
597
598 .. ghc-flag:: -Wdodgy-exports
599     :shortdesc: warn about dodgy exports
600     :type: dynamic
601     :reverse: -Wno-dodgy-exports
602     :category:
603
604     Causes a warning to be emitted when a datatype ``T`` is exported
605     with all constructors, i.e. ``T(..)``, but is it just a type
606     synonym.
607
608     Also causes a warning to be emitted when a module is re-exported,
609     but that module exports nothing.
610
611 .. ghc-flag:: -Wdodgy-imports
612     :shortdesc: warn about dodgy imports
613     :type: dynamic
614     :reverse: -Wno-dodgy-imports
615     :category:
616
617     Causes a warning to be emitted in the following cases:
618
619     -  When a datatype ``T`` is imported with all constructors, i.e.
620        ``T(..)``, but has been exported abstractly, i.e. ``T``.
621
622     -  When an ``import`` statement hides an entity that is not
623        exported.
624
625 .. ghc-flag:: -Woverflowed-literals
626     :shortdesc: warn about literals that will overflow their type
627     :type: dynamic
628     :reverse: -Wno-overflowed-literals
629     :category:
630
631     Causes a warning to be emitted if a literal will overflow, e.g.
632     ``300 :: Word8``.
633
634 .. ghc-flag:: -Wempty-enumerations
635     :shortdesc: warn about enumerations that are empty
636     :type: dynamic
637     :reverse: -Wno-empty-enumerations
638     :category:
639
640     Causes a warning to be emitted if an enumeration is empty, e.g.
641     ``[5 .. 3]``.
642
643 .. ghc-flag:: -Wderiving-defaults
644     :shortdesc: warn about default deriving when using both
645         :extension:`DeriveAnyClass` and :extension:`GeneralizedNewtypeDeriving`
646     :type: dynamic
647     :reverse: -Wno-deriving-defaults
648     :category:
649
650     :since: 8.10
651
652     Causes a warning when both :extension:`DeriveAnyClass` and
653     :extension:`GeneralizedNewtypeDeriving` are enabled and no explicit
654     deriving strategy is in use.  For example, this would result a
655     warning: ::
656
657         class C a
658         newtype T a = MkT a deriving C
659
660 .. ghc-flag:: -Wduplicate-constraints
661     :shortdesc: warn when a constraint appears duplicated in a type signature
662     :type: dynamic
663     :reverse: -Wno-duplicate-constraints
664     :category:
665
666     .. index::
667        single: duplicate constraints, warning
668
669     Have the compiler warn about duplicate constraints in a type
670     signature. For example ::
671
672         f :: (Eq a, Show a, Eq a) => a -> a
673
674     The warning will indicate the duplicated ``Eq a`` constraint.
675
676     This option is now deprecated in favour of
677     :ghc-flag:`-Wredundant-constraints`.
678
679 .. ghc-flag:: -Wredundant-constraints
680     :shortdesc: Have the compiler warn about redundant constraints in type
681         signatures.
682     :type: dynamic
683     :reverse: -Wno-redundant-constraints
684     :category:
685
686     :since: 8.0
687
688     .. index::
689        single: redundant constraints, warning
690
691     Have the compiler warn about redundant constraints in a type
692     signature. In particular:
693
694     -  A redundant constraint within the type signature itself: ::
695
696             f :: (Eq a, Ord a) => a -> a
697
698        The warning will indicate the redundant ``Eq a`` constraint: it
699        is subsumed by the ``Ord a`` constraint.
700
701     -  A constraint in the type signature is not used in the code it
702        covers: ::
703
704             f :: Eq a => a -> a -> Bool
705             f x y = True
706
707        The warning will indicate the redundant ``Eq a`` constraint: : it
708        is not used by the definition of ``f``.)
709
710     Similar warnings are given for a redundant constraint in an instance
711     declaration.
712
713     When turning on, you can suppress it on a per-module basis with
714     :ghc-flag:`-Wno-redundant-constraints <-Wredundant-constraints>`.
715     Occasionally you may specifically want a function to have a more
716     constrained signature than necessary, perhaps to leave yourself
717     wiggle-room for changing the implementation without changing the
718     API. In that case, you can suppress the warning on a per-function
719     basis, using a call in a dead binding. For example: ::
720
721         f :: Eq a => a -> a -> Bool
722         f x y = True
723         where
724             _ = x == x  -- Suppress the redundant-constraint warning for (Eq a)
725
726     Here the call to ``(==)`` makes GHC think that the ``(Eq a)``
727     constraint is needed, so no warning is issued.
728
729 .. ghc-flag:: -Wduplicate-exports
730     :shortdesc: warn when an entity is exported multiple times
731     :type: dynamic
732     :reverse: -Wno-duplicate-exports
733     :category:
734
735     .. index::
736        single: duplicate exports, warning
737        single: export lists, duplicates
738
739     Have the compiler warn about duplicate entries in export lists. This
740     is useful information if you maintain large export lists, and want
741     to avoid the continued export of a definition after you've deleted
742     (one) mention of it in the export list.
743
744     This option is on by default.
745
746 .. ghc-flag:: -Widentities
747     :shortdesc: warn about uses of Prelude numeric conversions that are probably
748         the identity (and hence could be omitted)
749     :type: dynamic
750     :reverse: -Wno-identities
751     :category:
752
753     Causes the compiler to emit a warning when a Prelude numeric
754     conversion converts a type ``T`` to the same type ``T``; such calls are
755     probably no-ops and can be omitted. The functions checked for are:
756     ``toInteger``, ``toRational``, ``fromIntegral``, and ``realToFrac``.
757
758 .. ghc-flag:: -Wimplicit-kind-vars
759     :shortdesc: warn when kind variables are implicitly quantified over.
760     :type: dynamic
761     :reverse: -Wno-implicit-kind-vars
762     :category:
763
764     .. index::
765        single: implicit prelude, warning
766
767     Have the compiler warn if a kind variable is not explicitly quantified
768     over. For instance, the following would produce a warning: ::
769
770         f :: forall (a :: k). Proxy a
771
772     This can be fixed by explicitly quantifying over ``k``: ::
773
774         f :: forall k (a :: k). Proxy a
775
776 .. ghc-flag:: -Wimplicit-prelude
777     :shortdesc: warn when the Prelude is implicitly imported
778     :type: dynamic
779     :reverse: -Wno-implicit-prelude
780     :category:
781
782     .. index::
783        single: implicit prelude, warning
784
785     Have the compiler warn if the Prelude is implicitly imported. This happens
786     unless either the Prelude module is explicitly imported with an ``import
787     ... Prelude ...`` line, or this implicit import is disabled (either by
788     :extension:`NoImplicitPrelude` or a ``LANGUAGE NoImplicitPrelude``
789     pragma).
790
791     Note that no warning is given for syntax that implicitly refers to the
792     Prelude, even if :extension:`NoImplicitPrelude` would change whether it
793     refers to the Prelude. For example, no warning is given when ``368`` means
794     ``Prelude.fromInteger (368::Prelude.Integer)`` (where ``Prelude`` refers
795     to the actual Prelude module, regardless of the imports of the module
796     being compiled).
797
798     This warning is off by default.
799
800 .. ghc-flag:: -Wincomplete-patterns
801     :shortdesc: warn when a pattern match could fail
802     :type: dynamic
803     :reverse: -Wno-incomplete-patterns
804     :category:
805
806     .. index::
807        single: incomplete patterns, warning
808        single: patterns, incomplete
809
810     The option :ghc-flag:`-Wincomplete-patterns` warns about places where a
811     pattern-match might fail at runtime. The function ``g`` below will
812     fail when applied to non-empty lists, so the compiler will emit a
813     warning about this when :ghc-flag:`-Wincomplete-patterns` is enabled. ::
814
815         g [] = 2
816
817     This option isn't enabled by default because it can be a bit noisy,
818     and it doesn't always indicate a bug in the program. However, it's
819     generally considered good practice to cover all the cases in your
820     functions, and it is switched on by :ghc-flag:`-W`.
821
822
823 .. ghc-flag:: -Wincomplete-uni-patterns
824     :shortdesc: warn when a pattern match in a lambda expression or
825         pattern binding could fail
826     :type: dynamic
827     :reverse: -Wno-incomplete-uni-patterns
828     :category:
829
830     The flag :ghc-flag:`-Wincomplete-uni-patterns` is similar to
831     :ghc-flag:`-Wincomplete-patterns`, except that it applies only to
832     lambda-expressions and pattern bindings, constructs that only allow a
833     single pattern: ::
834
835         h = \[] -> 2
836         Just k = f y
837
838 .. ghc-flag:: -fmax-pmcheck-models=⟨n⟩
839     :shortdesc: soft limit on the number of parallel models the pattern match
840         checker should check a pattern match clause against
841     :type: dynamic
842     :category:
843
844     :default: 100
845
846     The pattern match checker works by assigning symbolic values to each
847     pattern. We call each such assignment a 'model'. Now, each pattern match
848     clause leads to potentially multiple splits of that model, encoding
849     different ways for the pattern match to fail. For example, when matching
850     ``x`` against ``Just 4``, we split each incoming matching model into two
851     uncovered sub-models: One where ``x`` is ``Nothing`` and one where ``x`` is
852     ``Just y`` but ``y`` is not ``4``.
853
854     This can be exponential in the arity of the pattern and in the number of
855     guards in some cases. The :ghc-flag:`-fmax-pmcheck-models=⟨n⟩` limit makes sure
856     we scale polynomially in the number of patterns, by forgetting refined
857     information gained from a partially successful match. For the above example,
858     if we had a limit of 1, we would continue checking the next clause with the
859     original, unrefined model.
860
861 .. ghc-flag:: -Wincomplete-record-updates
862     :shortdesc: warn when a record update could fail
863     :type: dynamic
864     :reverse: -Wno-incomplete-record-updates
865     :category:
866
867     .. index::
868        single: incomplete record updates, warning
869        single: record updates, incomplete
870
871     The function ``f`` below will fail when applied to ``Bar``, so the
872     compiler will emit a warning about this when
873     :ghc-flag:`-Wincomplete-record-updates` is enabled. ::
874
875         data Foo = Foo { x :: Int }
876                  | Bar
877
878         f :: Foo -> Foo
879         f foo = foo { x = 6 }
880
881     This option isn't enabled by default because it can be very noisy,
882     and it often doesn't indicate a bug in the program.
883
884 .. ghc-flag:: -Wmissing-deriving-strategies
885     :shortdesc: warn when a deriving clause is missing a deriving strategy
886     :type: dynamic
887     :reverse: -Wno-missing-deriving-strategies
888     :category:
889
890     :since: 8.8.1
891
892     The datatype below derives the ``Eq`` typeclass, but doesn't specify a
893     strategy. When :ghc-flag:`-Wmissing-deriving-strategies` is enabled,
894     the compiler will emit a warning about this. ::
895
896         data Foo a = Foo a
897           deriving (Eq)
898
899     The compiler will warn here that the deriving clause doesn't specify a
900     strategy. If the warning is enabled, but :extension:`DerivingStrategies` is
901     not enabled, the compiler will suggest turning on the
902     :extension:`DerivingStrategies` extension. This option is not on by default,
903     having to be turned on manually or with :ghc-flag:`-Weverything`.
904
905 .. ghc-flag:: -Wmissing-fields
906     :shortdesc: warn when fields of a record are uninitialised
907     :type: dynamic
908     :reverse: -Wno-missing-fields
909     :category:
910
911     .. index::
912        single: missing fields, warning
913        single: fields, missing
914
915     This option is on by default, and warns you whenever the
916     construction of a labelled field constructor isn't complete, missing
917     initialisers for one or more fields. While not an error (the missing
918     fields are initialised with bottoms), it is often an indication of a
919     programmer error.
920
921 .. ghc-flag:: -Wmissing-export-lists
922     :shortdesc: warn when a module declaration does not explicitly list all
923         exports
924     :type: dynamic
925     :reverse: -fnowarn-missing-export-lists
926     :category:
927
928     :since: 8.4.1
929
930     .. index::
931        single: missing export lists, warning
932        single: export lists, missing
933
934     This flag warns if you declare a module without declaring an explicit
935     export list. For example ::
936
937         module M where
938
939           p x = x
940
941     The :ghc-flag:`-Wmissing-export-lists` flag will warn that ``M`` does not
942     declare an export list. Declaring an explicit export list for ``M`` enables
943     GHC dead code analysis, prevents accidental export of names and can ease
944     optimizations like inlining.
945
946 .. ghc-flag:: -Wmissing-import-lists
947     :shortdesc: warn when an import declaration does not explicitly list all the
948         names brought into scope
949     :type: dynamic
950     :reverse: -fnowarn-missing-import-lists
951     :category:
952
953     .. index::
954        single: missing import lists, warning
955        single: import lists, missing
956
957     This flag warns if you use an unqualified ``import`` declaration
958     that does not explicitly list the entities brought into scope. For
959     example ::
960
961         module M where
962           import X( f )
963           import Y
964           import qualified Z
965           p x = f x x
966
967     The :ghc-flag:`-Wmissing-import-lists` flag will warn about the import of
968     ``Y`` but not ``X`` If module ``Y`` is later changed to export (say) ``f``,
969     then the reference to ``f`` in ``M`` will become ambiguous. No warning is
970     produced for the import of ``Z`` because extending ``Z``\'s exports would be
971     unlikely to produce ambiguity in ``M``.
972
973 .. ghc-flag:: -Wmissing-methods
974     :shortdesc: warn when class methods are undefined
975     :type: dynamic
976     :reverse: -Wno-missing-methods
977     :category:
978
979     .. index::
980        single: missing methods, warning
981        single: methods, missing
982
983     This option is on by default, and warns you whenever an instance
984     declaration is missing one or more methods, and the corresponding
985     class declaration has no default declaration for them.
986
987     The ``MINIMAL`` pragma can be used to change which combination of
988     methods will be required for instances of a particular class. See
989     :ref:`minimal-pragma`.
990
991 .. ghc-flag:: -Wmissing-signatures
992     :shortdesc: warn about top-level functions without signatures
993     :type: dynamic
994     :reverse: -Wno-missing-signatures
995     :category:
996
997     .. index::
998        single: type signatures, missing
999
1000     If you would like GHC to check that every top-level function/value
1001     has a type signature, use the :ghc-flag:`-Wmissing-signatures` option.
1002     As part of the warning GHC also reports the inferred type. The
1003     option is off by default.
1004
1005 .. ghc-flag:: -Wmissing-exported-sigs
1006     :shortdesc: *(deprecated)*
1007         warn about top-level functions without signatures, only if they
1008         are exported. takes precedence over -Wmissing-signatures
1009     :type: dynamic
1010     :reverse: -Wno-missing-exported-sigs
1011     :category:
1012
1013     .. index::
1014        single: type signatures, missing
1015
1016     This option is now deprecated in favour of
1017     :ghc-flag:`-Wmissing-exported-signatures`.
1018
1019 .. ghc-flag:: -Wmissing-exported-signatures
1020     :shortdesc: warn about top-level functions without signatures, only if they
1021         are exported. takes precedence over -Wmissing-signatures
1022     :type: dynamic
1023     :reverse: -Wno-missing-exported-signatures
1024     :category:
1025
1026     .. index::
1027        single: type signatures, missing
1028
1029     If you would like GHC to check that every exported top-level
1030     function/value has a type signature, but not check unexported
1031     values, use the :ghc-flag:`-Wmissing-exported-signatures`
1032     option. This option takes precedence over
1033     :ghc-flag:`-Wmissing-signatures`. As part of the warning GHC also
1034     reports the inferred type. The option is off by default.
1035
1036 .. ghc-flag:: -Wmissing-local-sigs
1037     :shortdesc: *(deprecated)*
1038         warn about polymorphic local bindings without signatures
1039     :type: dynamic
1040     :reverse: -Wno-missing-local-sigs
1041     :category:
1042
1043     .. index::
1044        single: type signatures, missing
1045
1046     This option is now deprecated in favour of
1047     :ghc-flag:`-Wmissing-local-signatures`.
1048
1049 .. ghc-flag:: -Wmissing-local-signatures
1050     :shortdesc: warn about polymorphic local bindings without signatures
1051     :type: dynamic
1052     :reverse: -Wno-missing-local-signatures
1053     :category:
1054
1055     .. index::
1056        single: type signatures, missing
1057
1058     If you use the :ghc-flag:`-Wmissing-local-signatures` flag GHC
1059     will warn you about any polymorphic local bindings. As part of the
1060     warning GHC also reports the inferred type. The option is off by
1061     default.
1062
1063 .. ghc-flag:: -Wmissing-pattern-synonym-signatures
1064     :shortdesc: warn when pattern synonyms do not have type signatures
1065     :type: dynamic
1066     :reverse: -Wno-missing-pattern-synonym-signatures
1067     :category:
1068
1069     .. index::
1070          single: type signatures, missing, pattern synonyms
1071
1072     If you would like GHC to check that every pattern synonym has a
1073     type signature, use the
1074     :ghc-flag:`-Wmissing-pattern-synonym-signatures` option. If this
1075     option is used in conjunction with
1076     :ghc-flag:`-Wmissing-exported-signatures` then only exported pattern
1077     synonyms must have a type signature. GHC also reports the inferred
1078     type. This option is off by default.
1079
1080 .. ghc-flag:: -Wname-shadowing
1081     :shortdesc: warn when names are shadowed
1082     :type: dynamic
1083     :reverse: -Wno-name-shadowing
1084     :category:
1085
1086     .. index::
1087        single: shadowing, warning
1088
1089     This option causes a warning to be emitted whenever an inner-scope
1090     value has the same name as an outer-scope value, i.e. the inner
1091     value shadows the outer one. This can catch typographical errors
1092     that turn into hard-to-find bugs, e.g., in the inadvertent capture
1093     of what would be a recursive call in
1094     ``f = ... let f = id in ... f ...``.
1095
1096     The warning is suppressed for names beginning with an underscore.
1097     For example ::
1098
1099         f x = do { _ignore <- this; _ignore <- that; return (the other) }
1100
1101 .. ghc-flag:: -Worphans
1102     :shortdesc: warn when the module contains :ref:`orphan instance declarations
1103         or rewrite rules <orphan-modules>`
1104     :type: dynamic
1105     :reverse: -Wno-orphans
1106     :category:
1107
1108     .. index::
1109        single: orphan instances, warning
1110        single: orphan rules, warning
1111
1112     These flags cause a warning to be emitted whenever the module
1113     contains an "orphan" instance declaration or rewrite rule. An
1114     instance declaration is an orphan if it appears in a module in which
1115     neither the class nor the type being instanced are declared in the
1116     same module. A rule is an orphan if it is a rule for a function
1117     declared in another module. A module containing any orphans is
1118     called an orphan module.
1119
1120     The trouble with orphans is that GHC must pro-actively read the
1121     interface files for all orphan modules, just in case their instances
1122     or rules play a role, whether or not the module's interface would
1123     otherwise be of any use. See :ref:`orphan-modules` for details.
1124
1125     The flag :ghc-flag:`-Worphans` warns about user-written orphan rules or
1126     instances.
1127
1128 .. ghc-flag:: -Woverlapping-patterns
1129     :shortdesc: warn about overlapping patterns
1130     :type: dynamic
1131     :reverse: -Wno-overlapping-patterns
1132     :category:
1133
1134     .. index::
1135        single: overlapping patterns, warning
1136        single: patterns, overlapping
1137
1138     By default, the compiler will warn you if a set of patterns are
1139     overlapping, e.g., ::
1140
1141         f :: String -> Int
1142         f []     = 0
1143         f (_:xs) = 1
1144         f "2"    = 2
1145
1146     where the last pattern match in ``f`` won't ever be reached, as the
1147     second pattern overlaps it. More often than not, redundant patterns
1148     is a programmer mistake/error, so this option is enabled by default.
1149
1150 .. ghc-flag:: -Winaccessible-code
1151     :shortdesc: warn about inaccessible code
1152     :type: dynamic
1153     :reverse: -Wno-inaccessible-code
1154     :category:
1155
1156     .. index::
1157        single: inaccessible code, warning
1158        single: inaccessible
1159
1160     By default, the compiler will warn you if types make a branch inaccessible.
1161     This generally requires GADTs or similar extensions.
1162
1163     Take, for example, the following program ::
1164
1165         {-# LANGUAGE GADTs #-}
1166
1167         data Foo a where
1168          Foo1 :: Foo Char
1169          Foo2 :: Foo Int
1170
1171         data TyEquality a b where
1172                 Refl :: TyEquality a a
1173
1174         checkTEQ :: Foo t -> Foo u -> Maybe (TyEquality t u)
1175         checkTEQ x y = error "unimportant"
1176
1177         step2 :: Bool
1178         step2 = case checkTEQ Foo1 Foo2 of
1179                  Just Refl -> True -- Inaccessible code
1180                  Nothing -> False
1181
1182     The ``Just Refl`` case in ``step2`` is inaccessible, because in order for
1183     ``checkTEQ`` to be able to produce a ``Just``, ``t ~ u`` must hold, but
1184     since we're passing ``Foo1`` and ``Foo2`` here, it follows that ``t ~
1185     Char``, and ``u ~ Int``, and thus ``t ~ u`` cannot hold.
1186
1187 .. ghc-flag:: -Wstar-is-type
1188      :shortdesc: warn when ``*`` is used to mean ``Data.Kind.Type``
1189      :type: dynamic
1190      :reverse: -Wno-star-is-type
1191      :category:
1192
1193      :since: 8.6
1194
1195      The use of ``*`` to denote the kind of inhabited types relies on the
1196      :extension:`StarIsType` extension, which in a future release will be
1197      turned off by default and then possibly removed. The reasons for this and
1198      the deprecation schedule are described in `GHC proposal #30
1199      <https://github.com/ghc-proposals/ghc-proposals/blob/master/proposals/0030-remove-star-kind.rst>`__.
1200
1201      This warning allows to detect such uses of ``*`` before the actual
1202      breaking change takes place. The recommended fix is to replace ``*`` with
1203      ``Type`` imported from ``Data.Kind``.
1204
1205      Being part of the :ghc-flag:`-Wcompat` option group, this warning is off by
1206      default, but will be switched on in a future GHC release.
1207
1208 .. ghc-flag:: -Wstar-binder
1209      :shortdesc: warn about binding the ``(*)`` type operator despite
1210          :extension:`StarIsType`
1211      :type: dynamic
1212      :reverse: -Wno-star-binder
1213
1214      Under :extension:`StarIsType`, a ``*`` in types is not an operator nor
1215      even a name, it is special syntax that stands for ``Data.Kind.Type``. This
1216      means that an expression like ``Either * Char`` is parsed as ``Either (*)
1217      Char`` and not ``(*) Either Char``.
1218
1219      In binding positions, we have similar parsing rules. Consider the following
1220      example ::
1221
1222          {-# LANGUAGE TypeOperators, TypeFamilies, StarIsType #-}
1223
1224          type family a + b
1225          type family a * b
1226
1227      While ``a + b`` is parsed as ``(+) a b`` and becomes a binding position for
1228      the ``(+)`` type operator, ``a * b`` is parsed as ``a (*) b`` and is rejected.
1229
1230      As a workaround, we allow to bind ``(*)`` in prefix form::
1231
1232          type family (*) a b
1233
1234      This is a rather fragile arrangement, as generally a programmer expects
1235      ``(*) a b`` to be equivalent to ``a * b``. With :ghc-flag:`-Wstar-binder`
1236      we warn when this special treatment of ``(*)`` takes place.
1237
1238 .. ghc-flag:: -Wsimplifiable-class-constraints
1239     :shortdesc: Warn about class constraints in a type signature that can
1240         be simplified using a top-level instance declaration.
1241     :type: dynamic
1242     :reverse: -Wno-simplifiable-class-constraints
1243     :category:
1244
1245     :since: 8.2
1246
1247     .. index::
1248        single: simplifiable class constraints, warning
1249
1250     Warn about class constraints in a type signature that can be simplified
1251     using a top-level instance declaration.  For example: ::
1252
1253        f :: Eq [a] => a -> a
1254
1255     Here the ``Eq [a]`` in the signature overlaps with the top-level
1256     instance for ``Eq [a]``.  GHC goes to some efforts to use the former,
1257     but if it should use the latter, it would then have an
1258     insoluble ``Eq a`` constraint.  Best avoided by instead writing: ::
1259
1260        f :: Eq a => a -> a
1261
1262     This option is on by default. As usual you can suppress it on a
1263     per-module basis with :ghc-flag:`-Wno-simplifiable-class-constraints
1264     <-Wsimplifiable-class-constraints>`.
1265
1266 .. ghc-flag:: -Wspace-after-bang
1267      :shortdesc: warn for missing space before the second argument
1268         of an infix definition of ``(!)`` when
1269         :extension:`BangPatterns` are not enabled
1270      :type: dynamic
1271      :reverse: -Wno-missing-space-after-bang
1272 .. ghc-flag:: -Wtabs
1273     :shortdesc: warn if there are tabs in the source file
1274     :type: dynamic
1275     :reverse: -Wno-tabs
1276     :category:
1277
1278     .. index::
1279        single: tabs, warning
1280
1281     Have the compiler warn if there are tabs in your source file.
1282
1283 .. ghc-flag:: -Wtype-defaults
1284     :shortdesc: warn when defaulting happens
1285     :type: dynamic
1286     :reverse: -Wno-type-defaults
1287     :category:
1288
1289     .. index::
1290        single: defaulting mechanism, warning
1291
1292     Have the compiler warn/inform you where in your source the Haskell
1293     defaulting mechanism for numeric types kicks in. This is useful
1294     information when converting code from a context that assumed one
1295     default into one with another, e.g., the ‘default default’ for
1296     Haskell 1.4 caused the otherwise unconstrained value ``1`` to be
1297     given the type ``Int``, whereas Haskell 98 and later defaults it to
1298     ``Integer``. This may lead to differences in performance and
1299     behaviour, hence the usefulness of being non-silent about this.
1300
1301     This warning is off by default.
1302
1303 .. ghc-flag:: -Wmonomorphism-restriction
1304     :shortdesc: warn when the Monomorphism Restriction is applied
1305     :type: dynamic
1306     :reverse: -Wno-monomorphism-restriction
1307     :category:
1308
1309     .. index::
1310        single: monomorphism restriction, warning
1311
1312     Have the compiler warn/inform you where in your source the Haskell
1313     Monomorphism Restriction is applied. If applied silently the MR can
1314     give rise to unexpected behaviour, so it can be helpful to have an
1315     explicit warning that it is being applied.
1316
1317     This warning is off by default.
1318
1319 .. ghc-flag:: -Wunsupported-llvm-version
1320     :shortdesc: Warn when using :ghc-flag:`-fllvm` with an unsupported
1321         version of LLVM.
1322     :type: dynamic
1323     :reverse: -Wno-monomorphism-restriction
1324     :category:
1325
1326     Warn when using :ghc-flag:`-fllvm` with an unsupported version of LLVM.
1327
1328 .. ghc-flag:: -Wmissed-extra-shared-lib
1329     :shortdesc: Warn when GHCi can't load a shared lib.
1330     :type: dynamic
1331     :reverse: -Wno-missed-extra-shared-lib
1332     :category:
1333
1334     Warn when GHCi can't load a shared lib it deduced it should load
1335     when loading a package and analyzing the extra-libraries stanza
1336     of the target package description.
1337
1338 .. ghc-flag:: -Wunticked-promoted-constructors
1339     :shortdesc: warn if promoted constructors are not ticked
1340     :type: dynamic
1341     :reverse: -Wno-unticked-promoted-constructors
1342     :category:
1343
1344     .. index::
1345        single: promoted constructor, warning
1346
1347     Warn if a promoted data constructor is used without a tick preceding
1348     its name.
1349
1350     For example: ::
1351
1352         data Nat = Succ Nat | Zero
1353
1354         data Vec n s where
1355           Nil  :: Vec Zero a
1356           Cons :: a -> Vec n a -> Vec (Succ n) a
1357
1358     Will raise two warnings because ``Zero`` and ``Succ`` are not
1359     written as ``'Zero`` and ``'Succ``.
1360
1361     This warning is enabled by default in :ghc-flag:`-Wall` mode.
1362
1363 .. ghc-flag:: -Wunused-binds
1364     :shortdesc: warn about bindings that are unused. Alias for
1365         :ghc-flag:`-Wunused-top-binds`, :ghc-flag:`-Wunused-local-binds` and
1366         :ghc-flag:`-Wunused-pattern-binds`
1367     :type: dynamic
1368     :reverse: -Wno-unused-binds
1369     :category:
1370
1371     .. index::
1372        single: unused binds, warning
1373        single: binds, unused
1374
1375     Report any function definitions (and local bindings) which are
1376     unused. An alias for
1377
1378     -  :ghc-flag:`-Wunused-top-binds`
1379     -  :ghc-flag:`-Wunused-local-binds`
1380     -  :ghc-flag:`-Wunused-pattern-binds`
1381
1382 .. ghc-flag:: -Wunused-top-binds
1383     :shortdesc: warn about top-level bindings that are unused
1384     :type: dynamic
1385     :reverse: -Wno-unused-top-binds
1386     :category:
1387
1388     .. index::
1389        single: unused binds, warning
1390        single: binds, unused
1391
1392     Report any function definitions which are unused.
1393
1394     More precisely, warn if a binding brings into scope a variable that
1395     is not used, except if the variable's name starts with an
1396     underscore. The "starts-with-underscore" condition provides a way to
1397     selectively disable the warning.
1398
1399     A variable is regarded as "used" if
1400
1401     -  It is exported, or
1402
1403     -  It appears in the right hand side of a binding that binds at
1404        least one used variable that is used
1405
1406     For example: ::
1407
1408         module A (f) where
1409         f = let (p,q) = rhs1 in t p  -- No warning: q is unused, but is locally bound
1410         t = rhs3                     -- No warning: f is used, and hence so is t
1411         g = h x                      -- Warning: g unused
1412         h = rhs2                     -- Warning: h is only used in the
1413                                      -- right-hand side of another unused binding
1414         _w = True                    -- No warning: _w starts with an underscore
1415
1416 .. ghc-flag:: -Wunused-local-binds
1417     :shortdesc: warn about local bindings that are unused
1418     :type: dynamic
1419     :reverse: -Wno-unused-local-binds
1420     :category:
1421
1422     .. index::
1423        single: unused binds, warning
1424        single: binds, unused
1425
1426     Report any local definitions which are unused. For example: ::
1427
1428         module A (f) where
1429         f = let (p,q) = rhs1 in t p  -- Warning: q is unused
1430         g = h x                      -- No warning: g is unused, but is a top-level binding
1431
1432 .. ghc-flag:: -Wunused-pattern-binds
1433     :shortdesc: warn about pattern match bindings that are unused
1434     :type: dynamic
1435     :reverse: -Wno-unused-pattern-binds
1436     :category:
1437
1438     .. index::
1439        single: unused binds, warning
1440        single: binds, unused
1441
1442     Warn if a pattern binding binds no variables at all, unless it is a
1443     lone wild-card pattern, or a banged pattern. For example: ::
1444
1445         Just _ = rhs3    -- Warning: unused pattern binding
1446         (_, _) = rhs4    -- Warning: unused pattern binding
1447         _  = rhs3        -- No warning: lone wild-card pattern
1448         !() = rhs4       -- No warning: banged pattern; behaves like seq
1449
1450     In general a lazy pattern binding `p = e` is a no-op if `p` does not
1451     bind any variables.
1452     The motivation for allowing lone wild-card patterns is they are not
1453     very different from ``_v = rhs3``, which elicits no warning; and
1454     they can be useful to add a type constraint, e.g. ``_ = x::Int``. A
1455     banged pattern (see :ref:`bang-patterns`) is *not* a no-op, because
1456     it forces evaluation, and is useful as an alternative to ``seq``.
1457
1458 .. ghc-flag:: -Wunused-imports
1459     :shortdesc: warn about unnecessary imports
1460     :type: dynamic
1461     :reverse: -Wno-unused-imports
1462     :category:
1463
1464     .. index::
1465        single: unused imports, warning
1466        single: imports, unused
1467
1468     Report any modules that are explicitly imported but never used.
1469     However, the form ``import M()`` is never reported as an unused
1470     import, because it is a useful idiom for importing instance
1471     declarations, which are anonymous in Haskell.
1472
1473 .. ghc-flag:: -Wunused-matches
1474     :shortdesc: warn about variables in patterns that aren't used
1475     :type: dynamic
1476     :reverse: -Wno-unused-matches
1477     :category:
1478
1479     .. index::
1480        single: unused matches, warning
1481        single: matches, unused
1482
1483     Report all unused variables which arise from term-level pattern matches,
1484     including patterns consisting of a single variable. For instance
1485     ``f x y = []`` would report ``x`` and ``y`` as unused. The warning
1486     is suppressed if the variable name begins with an underscore, thus: ::
1487
1488         f _x = True
1489
1490     Note that :ghc-flag:`-Wunused-matches` does not warn about variables which
1491     arise from type-level patterns, as found in type family and data family
1492     instances. This must be enabled separately through the
1493     :ghc-flag:`-Wunused-type-patterns` flag.
1494
1495 .. ghc-flag:: -Wunused-do-bind
1496     :shortdesc: warn about do bindings that appear to throw away values of types
1497         other than ``()``
1498     :type: dynamic
1499     :reverse: -Wno-unused-do-bind
1500     :category:
1501
1502     .. index::
1503        single: unused do binding, warning
1504        single: do binding, unused
1505
1506     Report expressions occurring in ``do`` and ``mdo`` blocks that
1507     appear to silently throw information away. For instance
1508     ``do { mapM popInt xs ; return 10 }`` would report the first
1509     statement in the ``do`` block as suspicious, as it has the type
1510     ``StackM [Int]`` and not ``StackM ()``, but that ``[Int]`` value is
1511     not bound to anything. The warning is suppressed by explicitly
1512     mentioning in the source code that your program is throwing
1513     something away: ::
1514
1515         do { _ <- mapM popInt xs ; return 10 }
1516
1517     Of course, in this particular situation you can do even better: ::
1518
1519         do { mapM_ popInt xs ; return 10 }
1520
1521 .. ghc-flag:: -Wunused-type-patterns
1522     :shortdesc: warn about unused type variables which arise from patterns in
1523         in type family and data family instances
1524     :type: dynamic
1525     :reverse: -Wno-unused-type-patterns
1526     :category:
1527
1528     .. index::
1529        single: unused type patterns, warning
1530        single: type patterns, unused
1531
1532     Report all unused implicitly bound type variables which arise from
1533     patterns in type family and data family instances. For instance: ::
1534
1535         type instance F x y = []
1536
1537     would report ``x`` and ``y`` as unused on the right hand side. The warning
1538     is suppressed if the type variable name begins with an underscore, like
1539     so: ::
1540
1541         type instance F _x _y = []
1542
1543     When :extension:`ExplicitForAll` is enabled, explicitly quantified type
1544     variables may also be identified as unused. For instance: ::
1545
1546         type instance forall x y. F x y = []
1547
1548     would still report ``x`` and ``y`` as unused on the right hand side
1549
1550     Unlike :ghc-flag:`-Wunused-matches`, :ghc-flag:`-Wunused-type-patterns` is
1551     not implied by :ghc-flag:`-Wall`. The rationale for this decision is that
1552     unlike term-level pattern names, type names are often chosen expressly for
1553     documentation purposes, so using underscores in type names can make the
1554     documentation harder to read.
1555
1556 .. ghc-flag:: -Wunused-foralls
1557     :shortdesc: warn about type variables in user-written
1558         ``forall``\\s that are unused
1559     :type: dynamic
1560     :reverse: -Wno-unused-foralls
1561     :category:
1562
1563     .. index::
1564        single: unused foralls, warning
1565        single: foralls, unused
1566
1567     Report all unused type variables which arise from explicit, user-written
1568     ``forall`` statements. For instance: ::
1569
1570         g :: forall a b c. (b -> b)
1571
1572     would report ``a`` and ``c`` as unused.
1573
1574 .. ghc-flag:: -Wunused-record-wildcards
1575     :shortdesc: Warn about record wildcard matches when none of the bound variables
1576       are used.
1577     :type: dynamic
1578     :reverse: -Wno-unused-record-wildcards
1579     :category:
1580
1581     :since: 8.10.1
1582
1583     .. index::
1584        single: unused, warning, record wildcards
1585
1586     Report all record wildcards where none of the variables bound implicitly
1587     are used. For instance: ::
1588
1589
1590         data P = P { x :: Int, y :: Int }
1591
1592         f1 :: P -> Int
1593         f1 P{..} = 1 + 3
1594
1595     would report that the ``P{..}`` match is unused.
1596
1597 .. ghc-flag:: -Wredundant-record-wildcards
1598     :shortdesc: Warn about record wildcard matches when the wildcard binds no patterns.
1599     :type: dynamic
1600     :reverse: -Wno-redundant-record-wildcards
1601     :category:
1602
1603     :since: 8.10.1
1604
1605     .. index::
1606        single: unused, warning, record wildcards
1607
1608     Report all record wildcards where the wild card match binds no patterns.
1609     For instance: ::
1610
1611
1612         data P = P { x :: Int, y :: Int }
1613
1614         f1 :: P -> Int
1615         f1 P{x,y,..} = x + y
1616
1617     would report that the ``P{x, y, ..}`` match has a redundant use of ``..``.
1618
1619
1620 .. ghc-flag:: -Wwrong-do-bind
1621     :shortdesc: warn about do bindings that appear to throw away monadic values
1622         that you should have bound instead
1623     :type: dynamic
1624     :reverse: -Wno-wrong-do-bind
1625     :category:
1626
1627     .. index::
1628        single: apparently erroneous do binding, warning
1629        single: do binding, apparently erroneous
1630
1631     Report expressions occurring in ``do`` and ``mdo`` blocks that
1632     appear to lack a binding. For instance
1633     ``do { return (popInt 10) ; return 10 }`` would report the first
1634     statement in the ``do`` block as suspicious, as it has the type
1635     ``StackM (StackM Int)`` (which consists of two nested applications
1636     of the same monad constructor), but which is not then "unpacked" by
1637     binding the result. The warning is suppressed by explicitly
1638     mentioning in the source code that your program is throwing
1639     something away: ::
1640
1641         do { _ <- return (popInt 10) ; return 10 }
1642
1643     For almost all sensible programs this will indicate a bug, and you
1644     probably intended to write: ::
1645
1646         do { popInt 10 ; return 10 }
1647
1648 .. ghc-flag:: -Winline-rule-shadowing
1649     :shortdesc: Warn if a rewrite RULE might fail to fire because the
1650         function might be inlined before the rule has a chance to fire.
1651         See :ref:`rules-inline`.
1652     :type: dynamic
1653     :reverse: -Wno-inline-rule-shadowing
1654     :category:
1655
1656     Warn if a rewrite RULE might fail to fire because the function might
1657     be inlined before the rule has a chance to fire. See
1658     :ref:`rules-inline`.
1659
1660 .. ghc-flag:: -Wcpp-undef
1661     :shortdesc: warn on uses of the `#if` directive on undefined identifiers
1662     :type: dynamic
1663     :category:
1664
1665     :since: 8.2
1666
1667     This flag passes ``-Wundef`` to the C pre-processor (if its being used)
1668     which causes the pre-processor to warn on uses of the `#if` directive on
1669     undefined identifiers.
1670
1671 .. ghc-flag:: -Wunbanged-strict-patterns
1672     :shortdesc: warn on pattern bind of unlifted variable that is neither bare
1673         nor banged
1674     :type: dynamic
1675     :reverse: -Wno-unbanged-strict-patterns
1676     :category:
1677
1678     This flag warns whenever you write a pattern that binds a variable whose
1679     type is unlifted, and yet the pattern is not a bang pattern nor a bare variable.
1680     See :ref:`glasgow-unboxed` for information about unlifted types.
1681
1682 .. ghc-flag:: -Wmissing-home-modules
1683     :shortdesc: warn when encountering a home module imported, but not listed
1684         on the command line. Useful for cabal to ensure GHC won't pick
1685         up modules, not listed neither in ``exposed-modules``, nor in
1686         ``other-modules``.
1687     :type: dynamic
1688     :reverse: -Wno-missing-home-modules
1689     :category:
1690
1691     :since: 8.2
1692
1693     When a module provided by the package currently being compiled
1694     (i.e. the "home" package) is imported, but not explicitly listed in
1695     command line as a target. Useful for Cabal to ensure GHC won't
1696     pick up modules, not listed neither in ``exposed-modules``, nor in
1697     ``other-modules``.
1698
1699 .. ghc-flag:: -Wpartial-fields
1700     :shortdesc: warn when defining a partial record field.
1701     :type: dynamic
1702     :reverse: -Wno-partial-fields
1703     :category:
1704
1705     :since: 8.4
1706
1707     The option :ghc-flag:`-Wpartial-fields` warns about record fields that could
1708     fail when accessed via a lacking constructor. The function ``f`` below will
1709     fail when applied to ``Bar``, so the compiler will emit a warning at its
1710     definition when :ghc-flag:`-Wpartial-fields` is enabled.
1711
1712     The warning is suppressed if the field name begins with an underscore. ::
1713
1714         data Foo = Foo { f :: Int } | Bar
1715
1716 .. ghc-flag:: -Wunused-packages
1717     :shortdesc: warn when package is requested on command line, but was never loaded.
1718     :type: dynamic
1719     :reverse: -Wno-unused-packages
1720     :category:
1721
1722     :since: 8.8
1723
1724     The option :ghc-flag:`-Wunused-packages` warns about packages, specified on
1725     command line via :ghc-flag:`-package ⟨pkg⟩` or
1726     :ghc-flag:`-package-id ⟨unit-id⟩`, but were not loaded during compication.
1727     Usually it means that you have an unused dependency.
1728
1729     You may want to enable this warning on a clean build or enable :ghc-flag:`-fforce-recomp`
1730     in order to get reliable results.
1731
1732 If you're feeling really paranoid, the :ghc-flag:`-dcore-lint` option is a good choice.
1733 It turns on heavyweight intra-pass sanity-checking within GHC. (It checks GHC's
1734 sanity, not yours.)