From: Duncan Coutts <duncan@well-typed.com>
Date: Sat, 4 Jul 2009 18:05:47 +0000 (+0000)
Subject: Document foreign import prim in the user guide
X-Git-Url: http://git.megacz.com/?a=commitdiff_plain;ds=sidebyside;h=cc8e41a3c5e05a1076254ab39a56074e70f9e863;p=ghc-hetmet.git

Document foreign import prim in the user guide
Basically just stat that it exists and refer to the ghc dev wiki
for the details, because we don't really want people using it.
---

diff --git a/docs/users_guide/ffi-chap.xml b/docs/users_guide/ffi-chap.xml
index 7e2c547..2d2c5a0 100644
--- a/docs/users_guide/ffi-chap.xml
+++ b/docs/users_guide/ffi-chap.xml
@@ -63,6 +63,21 @@ OK:
 </programlisting>
 </para>
       </sect2>
+
+      <sect2>
+        <title>Primitive imports</title>
+	<para>
+	  GHC extends the FFI with an additional calling convention
+	  <literal>prim</literal>, e.g.:
+<programlisting>
+   foreign import prim "foo" foo :: ByteArray# -> (# Int#, Int# #)
+</programlisting>
+	  This is used to import functions written in Cmm code that follow an
+	  internal GHC calling convention. This feature is not intended for
+	  use outside of the core libraries that come with GHC. For more
+	  details see the GHC developer wiki.
+	</para>
+      </sect2>
   </sect1>
 
   <sect1 id="ffi-ghc">