[project @ 2001-05-31 12:40:59 by simonmar]

- document -hidir option
- move -ohi documentation to "redirecting output" section
- remove duplicate -ohi in the flags table.
- add a warning about -ohi confusing the recompilation checker.

diff --git a/ghc/docs/users_guide/flags.sgml b/ghc/docs/users_guide/flags.sgml
index 780f485..a2037dc 100644 (file)
--- a/ghc/docs/users_guide/flags.sgml
+++ b/ghc/docs/users_guide/flags.sgml
@@ -125,6 +125,12 @@
              <entry>-</entry>
            </row>
            <row>
+             <entry><option>-hidir</option> <replaceable>dir</replaceable></entry>
+             <entry>set directory for interface files</entry>
+             <entry>static</entry>
+             <entry>-</entry>
+           </row>
+           <row>
              <entry><option>-hisuf</option> <replaceable>suffix</replaceable></entry>
              <entry>set the suffix to use for interface files</entry>
              <entry>static</entry>
@@ -276,12 +282,6 @@
          </thead>
          <tbody>
            <row>
-             <entry><option>-ohi</option> <replaceable>file</replaceable></entry>
-             <entry>Put the interface file in <replaceable>file</replaceable></entry>
-             <entry>static</entry>
-             <entry>-</entry>
-           </row>
-           <row>
              <entry><option>-ddump-hi</option></entry>
              <entry>Dump the new interface to stdout</entry>
              <entry>dynamic</entry>

diff --git a/ghc/docs/users_guide/separate_compilation.sgml b/ghc/docs/users_guide/separate_compilation.sgml
index 691701b..759bac9 100644 (file)
--- a/ghc/docs/users_guide/separate_compilation.sgml
+++ b/ghc/docs/users_guide/separate_compilation.sgml
@@ -123,19 +123,6 @@
 
       <variablelist>
        <varlistentry>
-         <term><option>-ohi</option>  <replaceable>file</replaceable></term>
-         <indexterm><primary><option>-ohi</option></primary>
-         </indexterm>
-         <listitem>
-           <para>The interface output may be directed to another file
-            <filename>bar2/Wurble.iface</filename> with the option
-            <option>-ohi bar2/Wurble.iface</option> (not recommended).
-            To avoid generating an interface at all, you can say
-            <literal>-ohi /dev/null</literal>, for example.</para>
-         </listitem>
-       </varlistentry>
-
-       <varlistentry>
          <term><option>-ddump-hi</option></term>
          <indexterm><primary><option>-ddump-hi</option></primary>
          </indexterm>

diff --git a/ghc/docs/users_guide/using.sgml b/ghc/docs/users_guide/using.sgml
index d42ee47..184c02d 100644 (file)
--- a/ghc/docs/users_guide/using.sgml
+++ b/ghc/docs/users_guide/using.sgml
@@ -581,6 +581,41 @@ ghc --make Main.hs
       </varlistentry>
 
       <varlistentry>
+       <term><option>-ohi</option>  <replaceable>file</replaceable></term>
+       <indexterm><primary><option>-ohi</option></primary>
+       </indexterm>
+       <listitem>
+         <para>The interface output may be directed to another file
+          <filename>bar2/Wurble.iface</filename> with the option
+          <option>-ohi bar2/Wurble.iface</option> (not
+          recommended).</para>
+
+         <para>WARNING: if you redirect the interface file somewhere
+         that GHC can't find it, then the recompilation checker may
+         get confused (at the least, you won't get any recompilation
+         avoidance).  We recommend using a combination of
+         <option>-hidir</option> and <option>-hisuf</option> options
+         instead, if possible.</para>
+
+         <para>To avoid generating an interface at all, you could use
+          this option to redirect the interface into the bit bucket:
+          <literal>-ohi /dev/null</literal>, for example.</para>
+       </listitem>
+      </varlistentry>
+      
+      <varlistentry>
+       <term><option>-hidir</option>  <replaceable>directory</replaceable></term>
+       <indexterm><primary><option>-hidir</option></primary>
+       </indexterm>
+       <listitem>
+         <para>Redirects all generated interface files into
+         <replaceable>directory</replaceable>, instead of the default
+         which is to place the interface file in the same directory
+         as the source file.</para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
        <term><option>-osuf</option> <replaceable>suffix</replaceable></term>
        <term><option>-hisuf</option> <replaceable>suffix</replaceable></term>
        <term><option>-hcsuf</option> <replaceable>suffix</replaceable></term>