Preliminary monad-comprehension patch (Trac #4370)
[ghc-hetmet.git] / docs / users_guide / separate_compilation.xml
index 727a133..099a91f 100644 (file)
@@ -440,6 +440,8 @@ $ ghc -c parse/Foo.hs parse/Bar.hs gurgle/Bumble.hs -odir `uname -m`
       </indexterm>
       <indexterm><primary><literal>.hc</literal> files, saving</primary>
       </indexterm>
+      <indexterm><primary><literal>.ll</literal> files, saving</primary>
+      </indexterm>
       <indexterm><primary><literal>.s</literal> files, saving</primary>
       </indexterm>
 
@@ -459,37 +461,36 @@ $ ghc -c parse/Foo.hs parse/Bar.hs gurgle/Bumble.hs -odir `uname -m`
            <para>Keep intermediate <literal>.hc</literal> files when
            doing <literal>.hs</literal>-to-<literal>.o</literal>
            compilations via C (NOTE: <literal>.hc</literal> files
-           aren't generated when using the native code generator, you
-           may need to use <option>-fvia-C</option> to force them
-           to be produced).</para>
+           are only generated by unregisterised compilers).</para>
          </listitem>
        </varlistentry>
 
        <varlistentry>
          <term>
-            <option>-keep-s-file</option>,
-            <option>-keep-s-files</option>
-            <indexterm><primary><option>-keep-s-file</option></primary></indexterm>
-            <indexterm><primary><option>-keep-s-files</option></primary></indexterm>
+            <option>-keep-llvm-file</option>,
+            <option>-keep-llvm-files</option>
+            <indexterm><primary><option>-keep-llvm-file</option></primary></indexterm>
+            <indexterm><primary><option>-keep-llvm-files</option></primary></indexterm>
           </term>
          <listitem>
-           <para>Keep intermediate <literal>.s</literal> files.</para>
+           <para>Keep intermediate <literal>.ll</literal> files when
+           doing <literal>.hs</literal>-to-<literal>.o</literal>
+           compilations via LLVM (NOTE: <literal>.ll</literal> files
+           aren't generated when using the native code generator, you
+           may need to use <option>-fllvm</option> to force them
+           to be produced).</para>
          </listitem>
        </varlistentry>
 
        <varlistentry>
          <term>
-            <option>-keep-raw-s-file</option>,
-            <option>-keep-raw-s-files</option>
-            <indexterm><primary><option>-keep-raw-s-file</option></primary></indexterm>
-            <indexterm><primary><option>-keep-raw-s-files</option></primary></indexterm>
+            <option>-keep-s-file</option>,
+            <option>-keep-s-files</option>
+            <indexterm><primary><option>-keep-s-file</option></primary></indexterm>
+            <indexterm><primary><option>-keep-s-files</option></primary></indexterm>
           </term>
          <listitem>
-           <para>Keep intermediate <literal>.raw-s</literal> files.
-           These are the direct output from the C compiler, before
-           GHC does &ldquo;assembly mangling&rdquo; to produce the
-           <literal>.s</literal> file.  Again, these are not produced
-           when using the native code generator.</para>
+           <para>Keep intermediate <literal>.s</literal> files.</para>
          </listitem>
        </varlistentry>
 
@@ -1025,15 +1026,7 @@ M.o : X.hi-boot
        <option>&ndash;&ndash;include-pkg-deps</option> option below).</para>
 
        <para>The dependency generation phase of GHC can take some
-        additional options, which you may find useful.  For historical
-        reasons, each option passed to the dependency generator from
-        the GHC command line must be preceded by
-        <literal>-optdep</literal>.  For example, to pass <literal>-f
-        .depend</literal> to the dependency generator, you say
-
-<screen>
-ghc -M -optdep-f -optdep.depend ...
-</screen>
+        additional options, which you may find useful.
 
        The options which affect dependency generation are:</para>
 
@@ -1042,15 +1035,7 @@ ghc -M -optdep-f -optdep.depend ...
            <term><option>-ddump-mod-cycles</option></term>
            <listitem>
              <para>Display a list of the cycles in the module graph. This is
-         useful when trying to eliminate such cycles.  You do not need the <literal>-optdep</literal> prefix
-         for this flag.</para>
-           </listitem>
-         </varlistentry>
-
-         <varlistentry>
-           <term><option>-w</option></term>
-           <listitem>
-             <para>Turn off warnings about interface file shadowing.</para>
+         useful when trying to eliminate such cycles.</para>
            </listitem>
          </varlistentry>
 
@@ -1066,14 +1051,14 @@ ghc -M -optdep-f -optdep.depend ...
          </varlistentry>
 
          <varlistentry>
-           <term><option>-f</option> <replaceable>file</replaceable></term>
+           <term><option>-dep-makefile</option> <replaceable>file</replaceable></term>
            <listitem>
              <para>Use <replaceable>file</replaceable> as the makefile,
               rather than <filename>makefile</filename> or
               <filename>Makefile</filename>.  If
               <replaceable>file</replaceable> doesn't exist,
               <command>mkdependHS</command> creates it.  We often use
-              <option>-f .depend</option> to put the dependencies in
+              <option>-dep-makefile .depend</option> to put the dependencies in
               <filename>.depend</filename> and then
               <command>include</command> the file
               <filename>.depend</filename> into
@@ -1081,21 +1066,8 @@ ghc -M -optdep-f -optdep.depend ...
            </listitem>
          </varlistentry>
 
-<!-- Retired with the move away from 'mkdependHS'.
-         <varlistentry>
-           <term><option>-o &lt;osuf&gt;</option></term>
-           <listitem>
-             <para>Use <filename>.&lt;osuf&gt;</filename> as the
-              "target file" suffix ( default: <literal>o</literal>).
-              Multiple <option>-o</option> flags are permitted
-              (GHC2.05 onwards).  Thus "<option>-o hc -o o</option>"
-              will generate dependencies for <filename>.hc</filename>
-              and <filename>.o</filename> files.</para>
-           </listitem>
-         </varlistentry>
--->
          <varlistentry>
-           <term><option>-s &lt;suf&gt;</option></term>
+           <term><option>-dep-suffix &lt;suf&gt;</option></term>
            <listitem>
              <para>Make extra dependencies that declare that files
               with suffix
@@ -1104,13 +1076,14 @@ ghc -M -optdep-f -optdep.depend ...
               <filename>.&lt;suf&gt;&lowbar;hi</filename>, or (for
               <literal>&lcub;-&num; SOURCE &num;-&rcub;</literal>
               imports) on <filename>.hi-boot</filename>.  Multiple
-              <option>-s</option> flags are permitted.  For example,
-              <option>-o hc -s a -s b</option> will make dependencies
-              for <filename>.hc</filename> on
+              <option>-dep-suffix</option> flags are permitted.  For example,
+              <option>-dep-suffix a -dep-suffix b</option>
+              will make dependencies
+              for <filename>.hs</filename> on
               <filename>.hi</filename>,
-              <filename>.a&lowbar;hc</filename> on
+              <filename>.a&lowbar;hs</filename> on
               <filename>.a&lowbar;hi</filename>, and
-              <filename>.b&lowbar;hc</filename> on
+              <filename>.b&lowbar;hs</filename> on
               <filename>.b&lowbar;hi</filename>.  (Useful in
               conjunction with NoFib "ways".)</para>
            </listitem>
@@ -1126,35 +1099,6 @@ ghc -M -optdep-f -optdep.depend ...
          </varlistentry>
 
          <varlistentry>
-           <term><option>-x</option></term>
-           <listitem>
-             <para>same as <option>&ndash;&ndash;exclude-module</option></para>
-           </listitem>
-         </varlistentry>
-
-<!-- Not currently implemented:
-         <varlistentry>
-           <term><option>&ndash;&ndash;exclude-directory=&lt;dirs&gt;</option></term>
-           <listitem>
-             <para>Regard the colon-separated list of directories
-              <filename>&lt;dirs&gt;</filename> as containing stable,
-              don't generate any dependencies on modules
-              therein.</para>
-           </listitem>
-         </varlistentry>
-
-         <varlistentry>
-           <term><option>&ndash;&ndash;include-module=&lt;file&gt;</option></term>
-           <listitem>
-             <para>Regard <filename>&lt;file&gt;</filename> as not
-              "stable"; i.e., generate dependencies on it (if
-              any). This option is normally used in conjunction with
-              the <option>&ndash;&ndash;exclude-directory</option> option.</para>
-           </listitem>
-         </varlistentry>
--->
-
-         <varlistentry>
            <term><option>&ndash;&ndash;include-pkg-deps</option></term>
            <listitem>
              <para>Regard modules imported from packages as unstable,
@@ -1279,7 +1223,6 @@ first line, GHC considers it an orphan module.
 
 <!-- Emacs stuff:
      ;;; Local Variables: ***
-     ;;; mode: xml ***
      ;;; sgml-parent-document: ("users_guide.xml" "book" "chapter" "sect1") ***
      ;;; End: ***
  -->