Document -fwarn-unrecognised-pragmas; fixes trac #3031
authorIan Lynagh <igloo@earth.li>
Thu, 5 Mar 2009 14:31:28 +0000 (14:31 +0000)
committerIan Lynagh <igloo@earth.li>
Thu, 5 Mar 2009 14:31:28 +0000 (14:31 +0000)
docs/users_guide/flags.xml
docs/users_guide/glasgow_exts.xml
docs/users_guide/using.xml

index 8356a28..171eaba 100644 (file)
          </row>
 
          <row>
+           <entry><option>-fwarn-unrecognised-pragmas</option></entry>
+           <entry>warn about uses of pragmas that GHC doesn't recognise</entry>
+           <entry>dynamic</entry>
+           <entry><option>-fno-warn-unrecognised-pragmas</option></entry>
+         </row>
+
+         <row>
            <entry><option>-fwarn-warnings-deprecations</option></entry>
            <entry>warn about uses of functions &amp; types that have warnings or deprecated pragmas</entry>
            <entry>dynamic</entry>
index 75ada1d..b7e8ca4 100644 (file)
@@ -6889,7 +6889,7 @@ Assertion failures can be caught, see the documentation for the
     <replaceable>word</replaceable>.  The various values for
     <replaceable>word</replaceable> that GHC understands are described
     in the following sections; any pragma encountered with an
-    unrecognised <replaceable>word</replaceable> is (silently)
+    unrecognised <replaceable>word</replaceable> is
     ignored. The layout rule applies in pragmas, so the closing <literal>#-}</literal>
     should start in a column to the right of the opening <literal>{-#</literal>. </para> 
 
index d6eb6ed..20bb687 100644 (file)
@@ -918,6 +918,23 @@ ghc -c Foo.hs</screen>
     <variablelist>
 
       <varlistentry>
+       <term><option>-fwarn-unrecognised-pragmas</option>:</term>
+       <listitem>
+         <indexterm><primary><option>-fwarn-unrecognised-pragmas</option></primary>
+         </indexterm>
+         <indexterm><primary>warnings</primary></indexterm>
+         <indexterm><primary>pragmas</primary></indexterm>
+         <para>Causes a warning to be emitted when a
+         pragma that GHC doesn't recognise is used. As well as pragmas
+      that GHC itself uses, GHC also recognises pragmas known to be used
+      by other tools, e.g. <literal>OPTIONS_HUGS</literal> and
+      <literal>DERIVE</literal>.</para>
+
+         <para>This option is on by default.</para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
        <term><option>-fwarn-warnings-deprecations</option>:</term>
        <listitem>
          <indexterm><primary><option>-fwarn-warnings-deprecations</option></primary>