diff options
| author | Simon Marlow <marlowsd@gmail.com> | 2009-08-02 19:06:14 +0000 |
|---|---|---|
| committer | Simon Marlow <marlowsd@gmail.com> | 2009-08-02 19:06:14 +0000 |
| commit | 1fc88da19dbc66bc12de38b2956e97a8b7835806 (patch) | |
| tree | 0f7281bd62b05ddb304ddb0ab800baa4749f48f9 /docs | |
| parent | d787ad2f38cf4ee5564b30ebf0ccf2ccd8ccd38b (diff) | |
| download | haskell-1fc88da19dbc66bc12de38b2956e97a8b7835806.tar.gz | |
mention that INCLUDE pragmas are accepted, but ignored
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/users_guide/glasgow_exts.xml | 23 |
1 files changed, 5 insertions, 18 deletions
diff --git a/docs/users_guide/glasgow_exts.xml b/docs/users_guide/glasgow_exts.xml index ea313904fa..56735d0746 100644 --- a/docs/users_guide/glasgow_exts.xml +++ b/docs/users_guide/glasgow_exts.xml @@ -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 <stdio.h> #-}</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"> |