[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 (file)
--- 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>