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

[project @ 2001-09-18 11:33:58 by simonmar]
document new --auto-ghci-libs option.
---

diff --git a/ghc/docs/users_guide/packages.sgml b/ghc/docs/users_guide/packages.sgml
index 1a98edd..b75a6d8 100644
--- a/ghc/docs/users_guide/packages.sgml
+++ b/ghc/docs/users_guide/packages.sgml
@@ -106,7 +106,7 @@
 
 	<listitem>
 	  <para>The Haskell code in a package may be built into one or
-	  more Unix libraries (e.g. <filename>libHSfoo.a</filename>),
+	  more archive libraries (e.g. <filename>libHSfoo.a</filename>),
 	  or a single DLL on Windows
 	  (e.g. <filename>HSfoo.dll</filename>).  The restriction to a
 	  single DLL on Windows is that the package system is used to
@@ -120,15 +120,14 @@
 	  <para>Versions of the Haskell libraries for use with GHCi
 	  may also be included: GHCi cannot load <literal>.a</literal>
 	  files directly, instead it will look for an object file
-	  called <filename>HSfoo.o</filename> (the object suffix
-	  varies between platforms, as usual) and load that.  An
-	  object file can be built from a <literal>.a</literal>
-	  archive as follows (using GNU <command>ld</command> on
-	  Unix):</para>
-
-<screen>
-ld -r --whole-archive -o HSfoo.o libHSfoo.a
-</screen>
+	  called <filename>HSfoo.o</filename> and load that.  The
+	  <literal>ghc-pkg</literal> tool can automatically build the
+	  GHCi version of each library, see <xref
+	  linkend="package-management">.  To build these libraries by
+	  hand from the <literal>.a</literal> archive, it is possible
+	  to use GNU <command>ld</command> as follows:</para>
+
+<screen>ld -r --whole-archive -o HSfoo.o libHSfoo.a</screen>
 	</listitem>
 
 	<listitem>
@@ -201,6 +200,28 @@ ld -r --whole-archive -o HSfoo.o libHSfoo.a
 	</varlistentry>
 
 	<varlistentry>
+	  <term><option>--auto-ghci-libs</option></term>
+	  <term><option>-g</option></term>
+	  <indexterm><primary><option>--auto-ghci-libs</option></primary>
+	      </indexterm>
+	  <listitem>
+	    <para>Automatically generate the GHCi
+	    <filename>.o</filename> version of each
+	    <filename>.a</filename> Haskell library, using GNU ld (if
+	    that is available).  Without this option,
+	    <literal>ghc-pkg</literal> will warn if GHCi versions of
+	    any Haskell libraries in the package don't exist.</para>
+	    
+	    <para>GHCi <literal>.o</literal> libraries don't
+	    necessarily have to live in the same directory as the
+	    corresponding <literal>.a</literal> library.  However,
+	    this option will cause the GHCi library to be created in
+	    the same directory as the <literal>.a</literal>
+	    library.</para>
+	  </listitem>
+	</varlistentry>
+
+	<varlistentry>
 	  <term><option>--config-file <replaceable>file</replaceable></option></term>
 	  <term><option>-f <replaceable>file</replaceable></option></term>
 	  <indexterm><primary><option>--config-file</option></primary>