From: simonmar <unknown>
Date: Fri, 28 Jan 2005 14:41:23 +0000 (+0000)
Subject: [project @ 2005-01-28 14:41:23 by simonmar]
X-Git-Tag: Initial_conversion_from_CVS_complete~1157
X-Git-Url: http://git.megacz.com/?a=commitdiff_plain;h=b220cc67a5c3b16415e7a8cb0976913b0a0a581a;p=ghc-hetmet.git

[project @ 2005-01-28 14:41:23 by simonmar]
x-ref INCLUDE pragmas
---

diff --git a/ghc/docs/users_guide/phases.xml b/ghc/docs/users_guide/phases.xml
index cd687a7..b5d087f 100644
--- a/ghc/docs/users_guide/phases.xml
+++ b/ghc/docs/users_guide/phases.xml
@@ -500,12 +500,20 @@ $ cat foo.hspp</screen>
 
     <para>If you are compiling with lots of foreign calls, you may
     need to tell the C&nbsp;compiler about some
-    <literal>&num;include</literal> files.  There is no real pretty
-    way to do this, but you can use this hack from the
-    command-line:</para>
+    <literal>&num;include</literal> files.  The Right Way to do this is to
+      add an <literal>INCLUDE</literal> pragma to the top of your source file
+      (<xref linkend="include-pragma" />):</para>
+
+<programlisting>{-# INCLUDE &lt;X/Xlib.h&gt; #-}</programlisting>
+      
+    <para>Sometimes this isn't convenient.  In those cases there's an
+      equivalent command-line option:</para>
 
 <screen>% ghc -c '-#include &lt;X/Xlib.h&gt;' Xstuff.lhs</screen>
 
+    <indexterm><primary><option>-#include</option></primary>
+    </indexterm>
+
   </sect2>
 
   <sect2 id="options-codegen">