diff options
| author | Simon Peyton Jones <simonpj@microsoft.com> | 2012-02-10 11:15:43 +0000 |
|---|---|---|
| committer | Simon Peyton Jones <simonpj@microsoft.com> | 2012-02-10 11:15:43 +0000 |
| commit | 62d1337711474452ae5cf61c3f914d8d8e2609b6 (patch) | |
| tree | 63f6b0c63ace54b77db79ebf4ae82882bc77cfbb /docs/users_guide | |
| parent | cc047084f6842f10a0767e976bde6c93582b53e7 (diff) | |
| download | haskell-62d1337711474452ae5cf61c3f914d8d8e2609b6.tar.gz | |
Document -fwarn-auto-orphans
Diffstat (limited to 'docs/users_guide')
| -rw-r--r-- | docs/users_guide/flags.xml | 4 | ||||
| -rw-r--r-- | docs/users_guide/using.xml | 10 |
2 files changed, 10 insertions, 4 deletions
diff --git a/docs/users_guide/flags.xml b/docs/users_guide/flags.xml index ae16811b0d..1ffd765046 100644 --- a/docs/users_guide/flags.xml +++ b/docs/users_guide/flags.xml @@ -1301,11 +1301,11 @@ </row> <row> - <entry><option>-fwarn-orphans</option></entry> + <entry><option>-fwarn-orphans, -fwarn-auto-orphans</option></entry> <entry>warn when the module contains <link linkend="orphan-modules">orphan instance declarations or rewrite rules</link></entry> <entry>dynamic</entry> - <entry><option>-fno-warn-orphans</option></entry> + <entry><option>-fno-warn-orphans, -fno-warn-auto-orphans</option></entry> </row> <row> diff --git a/docs/users_guide/using.xml b/docs/users_guide/using.xml index 169a5dfa23..ca28fc3888 100644 --- a/docs/users_guide/using.xml +++ b/docs/users_guide/using.xml @@ -1419,13 +1419,14 @@ module M where </varlistentry> <varlistentry> - <term><option>-fwarn-orphans</option>:</term> + <term><option>-fwarn-orphans, -fwarn-auto-orphans</option>:</term> <listitem> <indexterm><primary><option>-fwarn-orphans</option></primary></indexterm> + <indexterm><primary><option>-fwarn-auto-orphans</option></primary></indexterm> <indexterm><primary>orphan instances, warning</primary></indexterm> <indexterm><primary>orphan rules, warning</primary></indexterm> - <para>This option causes a warning to be emitted whenever the + <para>These flags cause a warning to be emitted whenever the module contains an "orphan" instance declaration or rewrite rule. An instance declaration is an orphan if it appears in a module in which neither the class nor the type being instanced are declared @@ -1437,6 +1438,11 @@ module M where play a role, whether or not the module's interface would otherwise be of any use. See <xref linkend="orphan-modules"/> for details. </para> + <para>The flag <option>-fwarn-orphans</option> warns about user-written + orphan rules or instances. The flag <option>-fwarn-auto-orphans</option> + warns about automatically-generated orphan rules, notably as a result of + specialising functions, for type classes (<literal>Specialise</literal>) + or argument values (<literal>SpecConstr</literal>).</para> </listitem> </varlistentry> |