Commit 4d13f3e6 authored by Simon Marlow's avatar Simon Marlow

Document hs_init() infelicity (#2863)

parent 818a2c19
......@@ -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>
......
......@@ -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
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment