summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorSimon Marlow <marlowsd@gmail.com>2008-12-09 16:43:22 +0000
committerSimon Marlow <marlowsd@gmail.com>2008-12-09 16:43:22 +0000
commit4d13f3e61e4dc3aaa169bad0b8d67e8256624aee (patch)
tree1f89e9dde95a953773ee0f377a7e1569fd7c8afa /docs
parent818a2c1927b7299387c8eb71f58a2415cb6e5354 (diff)
downloadhaskell-4d13f3e61e4dc3aaa169bad0b8d67e8256624aee.tar.gz
Document hs_init() infelicity (#2863)
Diffstat (limited to 'docs')
-rw-r--r--docs/users_guide/bugs.xml18
-rw-r--r--docs/users_guide/ffi-chap.xml3
2 files changed, 20 insertions, 1 deletions
diff --git a/docs/users_guide/bugs.xml b/docs/users_guide/bugs.xml
index 4d79d24268..7fd47c9a20 100644
--- a/docs/users_guide/bugs.xml
+++ b/docs/users_guide/bugs.xml
@@ -298,6 +298,24 @@ checking for duplicates. The reason for this is efficiency, pure and simple.
</variablelist>
</sect2>
+
+ <sect2 id="ffi-divergence">
+ <title>Divergence from the FFI specification</title>
+
+ <variablelist>
+ <varlistentry>
+ <term><literal>hs_init()</literal> not allowed
+ after <literal>hs_exit()</literal></term>
+ <listitem>
+ <para>The FFI spec requires the implementation to support
+ re-initialising itself after being shut down
+ with <literal>hs_exit()</literal>, but GHC does not
+ currently support that.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect2>
+
</sect1>
diff --git a/docs/users_guide/ffi-chap.xml b/docs/users_guide/ffi-chap.xml
index a016f10901..358c5a84da 100644
--- a/docs/users_guide/ffi-chap.xml
+++ b/docs/users_guide/ffi-chap.xml
@@ -251,7 +251,8 @@ int main(int argc, char *argv[])
<literal>hs_exit()</literal><footnote><para>The outermost
<literal>hs_exit()</literal> will actually de-initialise the
system. NOTE that currently GHC's runtime cannot reliably
- re-initialise after this has happened.</para>
+ re-initialise after this has happened,
+ see <xref linkend="ffi-divergence" />.</para>
</footnote>.</para>
<para>NOTE: when linking the final program, it is normally