mention that INCLUDE pragmas are accepted, but ignored
authorSimon Marlow <marlowsd@gmail.com>
Sun, 2 Aug 2009 19:06:14 +0000 (19:06 +0000)
committerSimon Marlow <marlowsd@gmail.com>
Sun, 2 Aug 2009 19:06:14 +0000 (19:06 +0000)
docs/users_guide/glasgow_exts.xml

index ea31390..56735d0 100644 (file)
@@ -7193,24 +7193,11 @@ Assertion failures can be caught, see the documentation for the
     <sect2 id="include-pragma">
       <title>INCLUDE pragma</title>
 
-      <para>The <literal>INCLUDE</literal> pragma is for specifying the names
-       of C header files that should be <literal>#include</literal>'d into
-       the C source code generated by the compiler for the current module (if
-       compiling via C).  For example:</para>
-
-<programlisting>
-{-# INCLUDE "foo.h" #-}
-{-# INCLUDE &lt;stdio.h&gt; #-}</programlisting>
-
-        <para><literal>INCLUDE</literal> is a file-header pragma (see <xref linkend="pragmas"/>).</para>
-
-      <para>An <literal>INCLUDE</literal> pragma is  the preferred alternative
-       to the <option>-#include</option> option (<xref
-         linkend="options-C-compiler" />), because the
-       <literal>INCLUDE</literal> pragma is understood by other
-       compilers.  Yet another alternative is to add the include file to each
-       <literal>foreign import</literal> declaration in your code, but we
-       don't recommend using this approach with GHC.</para>
+      <para>The <literal>INCLUDE</literal> used to be necessary for
+        specifying header files to be included when using the FFI and
+        compiling via C.  It is no longer required for GHC, but is
+        accepted (and ignored) for compatibility with other
+        compilers.</para>
     </sect2>
 
     <sect2 id="warning-deprecated-pragma">