From: simonmar <unknown>
Date: Tue, 25 Sep 2001 11:46:33 +0000 (+0000)
Subject: [project @ 2001-09-25 11:46:33 by simonmar]
X-Git-Tag: Approximately_9120_patches~918
X-Git-Url: http://git.megacz.com/?a=commitdiff_plain;h=096a1b9a9afac39761f515a126797163e46f44e9;p=ghc-hetmet.git

[project @ 2001-09-25 11:46:33 by simonmar]
Mention the use of the -no-hs-main flag when talking about linking
programs where main() is not provided by GHC.
---

diff --git a/ghc/docs/users_guide/ffi-chap.sgml b/ghc/docs/users_guide/ffi-chap.sgml
index c2d7b83..c1b0c8a 100644
--- a/ghc/docs/users_guide/ffi-chap.sgml
+++ b/ghc/docs/users_guide/ffi-chap.sgml
@@ -152,6 +152,13 @@ int main(int argc, char *argv[])
 	<para>The functions <literal>startupHaskell()</literal> and
 	<literal>shutdownHaskell()</literal> may be called only once
 	each, and only in that order.</para>
+
+	<para>NOTE: when linking the final program, it is normally
+	easiest to do the link using GHC, although this isn't
+	essential.  If you do use GHC, then don't forget the flag
+	<option>-no-hs-main</option><indexterm><primary><option>-no-hs-main</option></primary>
+	  </indexterm>, otherwise GHC will try to link
+	to the <literal>Main</literal> Haskell module.</para>
       </sect3>
 
       <sect3 id="foreign-export-dynamic-ghc">