Improve the correlation betweens documented and existent options

diff --git a/docs/users_guide/6.6-notes.xml b/docs/users_guide/6.6-notes.xml
index 1e2dd68..a161b54 100644 (file)
--- a/docs/users_guide/6.6-notes.xml
+++ b/docs/users_guide/6.6-notes.xml
@@ -171,7 +171,6 @@
             <option>-pgma</option>,
             <option>-pgml</option>,
             <option>-pgmdll</option>,
-            <option>-pgmdep</option>,
             <option>-pgmF</option>,
             <option>-optl</option>,
             <option>-optdll</option>,

diff --git a/docs/users_guide/debugging.xml b/docs/users_guide/debugging.xml
index b445627..2a88767 100644 (file)
--- a/docs/users_guide/debugging.xml
+++ b/docs/users_guide/debugging.xml
@@ -60,6 +60,27 @@
 
            <varlistentry>
              <term>
+               <option>-ddump-tc</option>:
+                <indexterm><primary><option>-ddump-tc</option></primary></indexterm>
+             </term>
+             <listitem>
+               <para>typechecker output</para>
+             </listitem>
+           </varlistentry>
+
+           <varlistentry>
+             <term>
+               <option>-ddump-splices</option>:
+                <indexterm><primary><option>-ddump-splices</option></primary></indexterm>
+             </term>
+             <listitem>
+               <para>Dump Template Haskell expressions that we splice in,
+                and what Haskell code the expression evaluates to.</para>
+             </listitem>
+           </varlistentry>
+
+           <varlistentry>
+             <term>
                <option>-ddump-types</option>:
                 <indexterm><primary><option>-ddump-types</option></primary></indexterm>
              </term>
@@ -186,6 +207,16 @@
 
            <varlistentry>
              <term>
+               <option>-ddump-prep</option>:
+                <indexterm><primary><option>-ddump-prep</option></primary></indexterm>
+             </term>
+             <listitem>
+               <para>output of core preparation pass</para>
+             </listitem>
+           </varlistentry>
+
+           <varlistentry>
+             <term>
                <option>-ddump-stg</option>:
                 <indexterm><primary><option>-ddump-stg</option></primary></indexterm>
              </term>
@@ -206,6 +237,26 @@
 
            <varlistentry>
              <term>
+               <option>-ddump-cmm</option>:
+                <indexterm><primary><option>-ddump-cmm</option></primary></indexterm>
+             </term>
+             <listitem>
+               <para>Print the C-- code out.</para>
+             </listitem>
+           </varlistentry>
+
+           <varlistentry>
+             <term>
+               <option>-ddump-opt-cmm</option>:
+                <indexterm><primary><option>-ddump-opt-cmm</option></primary></indexterm>
+             </term>
+             <listitem>
+               <para>Dump the results of C-- to C-- optimising passes.</para>
+             </listitem>
+           </varlistentry>
+
+           <varlistentry>
+             <term>
                <option>-ddump-asm</option>:
                 <indexterm><primary><option>-ddump-asm</option></primary></indexterm>
              </term>
@@ -265,6 +316,28 @@
 
       <varlistentry>
        <term>
+          <option>-ddump-if-trace</option>
+          <indexterm><primary><option>-ddump-if-trace</option></primary></indexterm>
+        </term>
+       <listitem>
+         <para>Make the interface loader be *real* chatty about what it is
+       upto.</para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
+       <term>
+          <option>-ddump-tc-trace</option>
+          <indexterm><primary><option>-ddump-tc-trace</option></primary></indexterm>
+        </term>
+       <listitem>
+         <para>Make the type checker be *real* chatty about what it is
+       upto.</para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
+       <term>
           <option>-ddump-rn-trace</option>
           <indexterm><primary><option>-ddump-rn-trace</option></primary></indexterm>
         </term>
@@ -308,12 +381,22 @@
       
       <varlistentry>
        <term>
+          <option>-dshow-passes</option>
+          <indexterm><primary><option>-dshow-passes</option></primary></indexterm>
+        </term>
+       <listitem>
+         <para>Print out each pass name as it happens.</para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
+       <term>
           <option>-dfaststring-stats</option>
           <indexterm><primary><option>-dfaststring-stats</option></primary></indexterm>
         </term>
        <listitem>
          <para>Show statistics for the usage of fast strings by the
-          compiler</para>
+          compiler.</para>
        </listitem>
       </varlistentry>
 
@@ -392,6 +475,16 @@
        </listitem>
       </varlistentry>
 
+      <varlistentry>
+       <term>
+          <option>-dcmm-lint</option>:
+          <indexterm><primary><option>-dcmm-lint</option></primary></indexterm>
+        </term>
+       <listitem>
+         <para>Ditto for C-- level.</para>
+       </listitem>
+      </varlistentry>
+
     </variablelist>
   </sect2>
 

diff --git a/docs/users_guide/flags.xml b/docs/users_guide/flags.xml
index 6a18ca5..cc5d6d3 100644 (file)
--- a/docs/users_guide/flags.xml
+++ b/docs/users_guide/flags.xml
@@ -36,6 +36,12 @@
              <entry>-</entry>
            </row>
            <row>
+             <entry><option>-n</option></entry>
+             <entry>do a dry run</entry>
+             <entry>dynamic</entry>
+             <entry>-</entry>
+           </row>
+           <row>
              <entry><option>-v</option></entry>
              <entry>verbose mode (equivalent to <option>-v3</option>)</entry>
              <entry>dynamic</entry>
@@ -78,6 +84,12 @@
              <entry>-</entry>
            </row>
            <row>
+             <entry><option>-H</option><replaceable>size</replaceable></entry>
+             <entry>Set the minimum heap size to <replaceable>size</replaceable></entry>
+             <entry>static</entry>
+             <entry>-</entry>
+           </row>
+           <row>
              <entry><option>-Rghc-timing</option></entry>
              <entry>Summarise timing stats for GHC (same as <literal>+RTS -tstderr</literal>)</entry>
              <entry>static</entry>
@@ -487,6 +499,12 @@
          </thead>
          <tbody>
            <row>
+             <entry><option>-package-name</option> <replaceable>P</replaceable></entry>
+             <entry>Compile to be part of package <replaceable>P</replaceable></entry>
+             <entry>dynamic</entry>
+             <entry>-</entry>
+           </row>
+           <row>
              <entry><option>-package</option> <replaceable>P</replaceable></entry>
              <entry>Expose package <replaceable>P</replaceable></entry>
              <entry>dynamic</entry>
@@ -1245,6 +1263,12 @@
          </thead>
          <tbody>
            <row>
+             <entry><option>-fPIC</option></entry>
+             <entry>Generate position-independent code (where available)</entry>
+             <entry>static</entry>
+             <entry>-</entry>
+           </row>
+           <row>
              <entry><option>-dynamic</option></entry>
              <entry>Use dynamic Haskell libraries (if available)</entry>
              <entry>static</entry>
@@ -1367,6 +1391,18 @@
              <entry>-</entry>
            </row>
            <row>
+             <entry><option>-pgmm</option> <replaceable>cmd</replaceable></entry>
+             <entry>Use <replaceable>cmd</replaceable> as the mangler</entry>
+             <entry>dynamic</entry>
+             <entry>-</entry>
+           </row>
+           <row>
+             <entry><option>-pgms</option> <replaceable>cmd</replaceable></entry>
+             <entry>Use <replaceable>cmd</replaceable> as the splitter</entry>
+             <entry>dynamic</entry>
+             <entry>-</entry>
+           </row>
+           <row>
              <entry><option>-pgma</option> <replaceable>cmd</replaceable></entry>
              <entry>Use <replaceable>cmd</replaceable> as the assembler</entry>
              <entry>dynamic</entry>
@@ -1385,12 +1421,6 @@
              <entry>-</entry>
            </row>
            <row>
-             <entry><option>-pgmdep</option> <replaceable>cmd</replaceable></entry>
-             <entry>Use <replaceable>cmd</replaceable> as the dependency generator</entry>
-             <entry>dyanmic</entry>
-             <entry>-</entry>
-           </row>
-           <row>
              <entry><option>-pgmF</option> <replaceable>cmd</replaceable></entry>
              <entry>Use <replaceable>cmd</replaceable> as the pre-processor
              (with <option>-F</option> only)</entry>
@@ -1406,7 +1436,6 @@
       <indexterm><primary><option>-pgma</option></primary></indexterm>
       <indexterm><primary><option>-pgml</option></primary></indexterm>
       <indexterm><primary><option>-pgmdll</option></primary></indexterm>
-      <indexterm><primary><option>-pgmdep</option></primary></indexterm>
       <indexterm><primary><option>-pgmF</option></primary></indexterm>
 
     </sect2>
@@ -1454,6 +1483,12 @@
              <entry>-</entry>
            </row>
            <row>
+             <entry><option>-optm</option> <replaceable>option</replaceable></entry>
+             <entry>pass <replaceable>option</replaceable> to the mangler</entry>
+             <entry>dynamic</entry>
+             <entry>-</entry>
+           </row>
+           <row>
              <entry><option>-opta</option> <replaceable>option</replaceable></entry>
              <entry>pass <replaceable>option</replaceable> to the assembler</entry>
              <entry>dynamic</entry>
@@ -1573,6 +1608,12 @@
              <entry>-</entry>
            </row>
            <row>
+             <entry><option>-ddump-cmm</option></entry>
+             <entry>Dump C-- output</entry>
+             <entry>dynamic</entry>
+             <entry>-</entry>
+           </row>
+           <row>
              <entry><option>-ddump-cpranal</option></entry>
              <entry>Dump output from CPR analysis</entry>
              <entry>dynamic</entry>
@@ -1621,12 +1662,24 @@
              <entry>-</entry>
            </row>
            <row>
+             <entry><option>-ddump-opt-cmm</option></entry>
+             <entry>Dump the results of C-- to C-- optimising passes</entry>
+             <entry>dynamic</entry>
+             <entry>-</entry>
+           </row>
+           <row>
              <entry><option>-ddump-parsed</option></entry>
              <entry>Dump parse tree</entry>
              <entry>dynamic</entry>
              <entry>-</entry>
            </row>
            <row>
+             <entry><option>-ddump-prep</option></entry>
+             <entry>Dump prepared core</entry>
+             <entry>dynamic</entry>
+             <entry>-</entry>
+           </row>
+           <row>
              <entry><option>-ddump-rn</option></entry>
              <entry>Dump renamer output</entry>
              <entry>dynamic</entry>
@@ -1657,6 +1710,12 @@
              <entry>-</entry>
            </row>
            <row>
+             <entry><option>-ddump-splices</option></entry>
+             <entry>Dump TH splided expressions, and what they evaluate to</entry>
+             <entry>dynamic</entry>
+             <entry>-</entry>
+           </row>
+           <row>
              <entry><option>-ddump-stg</option></entry>
              <entry>Dump final STG</entry>
              <entry>dynamic</entry>
@@ -1687,6 +1746,18 @@
              <entry>-</entry>
            </row>
            <row>
+             <entry><option>-ddump-if-trace</option></entry>
+             <entry>Trace interface files</entry>
+             <entry>dynamic</entry>
+             <entry>-</entry>
+           </row>
+           <row>
+             <entry><option>-ddump-tc-trace</option></entry>
+             <entry>Trace typechecker</entry>
+             <entry>dynamic</entry>
+             <entry>-</entry>
+           </row>
+           <row>
              <entry><option>-ddump-rn-trace</option></entry>
              <entry>Trace renamer</entry>
              <entry>dynamic</entry>
@@ -1729,6 +1800,12 @@
              <entry>-</entry>
            </row>
            <row>
+             <entry><option>-dcmm-lint</option></entry>
+             <entry>C-- pass sanity checking</entry>
+             <entry>dynamic</entry>
+             <entry>-</entry>
+           </row>
+           <row>
              <entry><option>-dstg-lint</option></entry>
              <entry>STG pass sanity checking</entry>
              <entry>dynamic</entry>
@@ -1753,6 +1830,12 @@
              <entry>-</entry>
            </row>
            <row>
+             <entry><option>-dshow-passes</option></entry>
+             <entry>Print out each pass name as it happens</entry>
+             <entry>dynamic</entry>
+             <entry>-</entry>
+           </row>
+           <row>
              <entry><option>-dfaststring-stats</option></entry>
              <entry>Show statistics for fast string usage when finished</entry>
              <entry>dynamic</entry>

diff --git a/docs/users_guide/phases.xml b/docs/users_guide/phases.xml
index 9058177..cd18469 100644 (file)
--- a/docs/users_guide/phases.xml
+++ b/docs/users_guide/phases.xml
@@ -49,6 +49,28 @@
 
       <varlistentry>
         <term>
+          <option>-pgmm</option> <replaceable>cmd</replaceable>
+          <indexterm><primary><option>-pgmm</option></primary></indexterm>
+        </term>
+        <listitem>
+          <para>Use <replaceable>cmd</replaceable> as the
+          mangler.</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>
+          <option>-pgms</option> <replaceable>cmd</replaceable>
+          <indexterm><primary><option>-pgms</option></primary></indexterm>
+        </term>
+        <listitem>
+          <para>Use <replaceable>cmd</replaceable> as the
+          splitter.</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>
           <option>-pgma</option> <replaceable>cmd</replaceable>
           <indexterm><primary><option>-pgma</option></primary></indexterm>
         </term>
@@ -82,17 +104,6 @@
 
       <varlistentry>
         <term>
-          <option>-pgmdep</option> <replaceable>cmd</replaceable>
-          <indexterm><primary><option>-pgmdep</option></primary></indexterm>
-        </term>
-        <listitem>
-          <para>Use <replaceable>cmd</replaceable> as the dependency
-          generator.</para>
-        </listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term>
           <option>-pgmF</option> <replaceable>cmd</replaceable>
           <indexterm><primary><option>-pgmF</option></primary></indexterm>
         </term>
@@ -155,6 +166,15 @@
       </varlistentry>
       <varlistentry>
         <term>
+          <option>-optm</option>  <replaceable>option</replaceable>
+          <indexterm><primary><option>-optm</option></primary></indexterm>
+        </term>
+        <listitem>
+          <para>Pass <replaceable>option</replaceable> to the mangler.</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>
           <option>-opta</option>  <replaceable>option</replaceable>
           <indexterm><primary><option>-opta</option></primary></indexterm>
         </term>

diff --git a/docs/users_guide/using.xml b/docs/users_guide/using.xml
index 14665af..aa133ee 100644 (file)
--- a/docs/users_guide/using.xml
+++ b/docs/users_guide/using.xml
@@ -592,6 +592,18 @@ ghc -c Foo.hs</screen>
 
       <varlistentry>
        <term>
+          <option>-n</option>
+          <indexterm><primary><option>-n</option></primary></indexterm>
+        </term>
+       <listitem>
+         <para>Does a dry-run, i.e. GHC goes through all the motions
+          of compiling as normal, but does not actually run any
+          external commands.</para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
+       <term>
           <option>-v</option>
           <indexterm><primary><option>-v</option></primary></indexterm>
         </term>
@@ -748,6 +760,20 @@ ghc -c Foo.hs</screen>
       </varlistentry>
 
       <varlistentry>
+        <term><option>-H</option><replaceable>size</replaceable>
+        <indexterm><primary><option>-H</option></primary></indexterm>
+        </term>
+        <listitem>
+          <para>Set the minimum size of the heap to
+          <replaceable>size</replaceable>.
+          This option is equivalent to
+          <literal>+RTS&nbsp;-H<replaceable>size</replaceable></literal>,
+          see <xref linkend="rts-options-gc" />.
+          </para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
         <term><option>-Rghc-timing</option>
         <indexterm><primary><option>-Rghc-timing</option></primary></indexterm>
         </term>