From: ross <unknown>
Date: Wed, 5 May 2004 12:00:10 +0000 (+0000)
Subject: [project @ 2004-05-05 12:00:10 by ross]
X-Git-Tag: Initial_conversion_from_CVS_complete~1875
X-Git-Url: http://git.megacz.com/?a=commitdiff_plain;h=2a538d224b533bc65ce1d8002cc1cbcec21ceb47;p=ghc-hetmet.git

[project @ 2004-05-05 12:00:10 by ross]
add a note about #def in hsc2hs
---

diff --git a/ghc/docs/users_guide/utils.sgml b/ghc/docs/users_guide/utils.sgml
index a0769b7..8d75b38 100644
--- a/ghc/docs/users_guide/utils.sgml
+++ b/ghc/docs/users_guide/utils.sgml
@@ -391,6 +391,15 @@ tags:
             <literal>inline</literal>, <literal>struct</literal> or
             <literal>typedef</literal> keyword must come just after
             <literal>def</literal>.</para>
+
+	    <note><para>A <literal>foreign import</literal> of a
+	    C function may be inlined across a module boundary,
+	    in which case you must arrange for the importing
+	    module to <literal>#include</literal> the C header
+	    file generated by <command>hsc2hs</command> (see
+	    <xref linkend="glasgow-foreign-headers">).
+	    For this reason we avoid using <literal>#def</literal>
+	    in the libraries.</para></note>
 	  </listitem>
 	</varlistentry>