Commit da6eff29 authored by simonmar's avatar simonmar
Browse files

[project @ 2005-01-28 14:41:09 by simonmar]

Document {-# INCLUDE #-}
parent b4b792b5
......@@ -4200,6 +4200,31 @@ 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>
{-# INCLUDE "foo.h" #-}
{-# INCLUDE &lt;stdio.h&gt; #-}</programlisting>
<para>The <literal>INCLUDE</literal> pragma(s) must appear at the top of
your source file with any <literal>OPTIONS_GHC</literal>
<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>
<sect2 id="inline-noinline-pragma">
<title>INLINE and NOINLINE pragmas</title>
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment