New syntax for GADT-style record declarations, and associated refactoring

[ghc-hetmet.git] / docs / users_guide / debugging.xml

diff --git a/docs/users_guide/debugging.xml b/docs/users_guide/debugging.xml
index 8a4129b..d6a520a 100644 (file)
--- a/docs/users_guide/debugging.xml
+++ b/docs/users_guide/debugging.xml
@@ -60,16 +60,6 @@
 
            <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>
@@ -290,14 +280,25 @@
       
       <varlistentry>
        <term>
+          <option>-ddump-simpl-phases</option>:
+          <indexterm><primary><option>-ddump-simpl-phases</option></primary></indexterm>
+        </term>
+       <listitem>
+         <para>Show the output of each run of the simplifier.  Used when even
+        <option>-dverbose-simpl</option> doesn't cut it.</para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
+       <term>
           <option>-ddump-simpl-iterations</option>:
           <indexterm><primary><option>-ddump-simpl-iterations</option></primary></indexterm>
         </term>
        <listitem>
          <para>Show the output of each <emphasis>iteration</emphasis>
         of the simplifier (each run of the simplifier has a maximum
-        number of iterations, normally 4).  Used when even
-        <option>-dverbose-simpl</option> doesn't cut it.</para>
+        number of iterations, normally 4).  This outputs even more information
+        than <option>-ddump-simpl-phases</option>.</para>
        </listitem>
       </varlistentry>
 
@@ -422,6 +423,20 @@
 
       <varlistentry>
        <term>
+          <option>-dsuppress-uniques</option>
+          <indexterm><primary><option>-dsuppress-uniques</option></primary></indexterm>
+        </term>
+       <listitem>
+         <para>Suppress the printing of uniques in debugging output. This may make 
+         the printout ambiguous (e.g. unclear where an occurrence of 'x' is bound), but
+         it makes the output of two compiler runs have many fewer gratuitous differences,
+           so you can realistically apply <command>diff</command>.  Once <command>diff</command>
+         has shown you where to look, you can try again without <option>-dsuppress-uniques</option></para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
+       <term>
           <option>-dppr-user-length</option>
           <indexterm><primary><option>-dppr-user-length</option></primary></indexterm>
         </term>
@@ -434,14 +449,18 @@
       </varlistentry>
 
       <varlistentry>
-       <term>
-          <option>-dshow-unused-imports</option>
-          <indexterm><primary><option>-dshow-unused-imports</option></primary></indexterm>
+        <term>
+          <option>-dno-debug-output</option>
+          <indexterm><primary><option>-dno-debug-output</option></primary></indexterm>
         </term>
-       <listitem>
-         <para>Have the renamer report what imports does not
-       contribute.</para>
-       </listitem>
+        <listitem>
+          <para>Suppress any unsolicited debugging output.  When GHC
+            has been built with the <literal>DEBUG</literal> option it
+            occasionally emits debug output of interest to developers.
+            The extra output can confuse the testing framework and
+            cause bogus test failures, so this flag is provided to
+            turn it off.</para>
+        </listitem>
       </varlistentry>
     </variablelist>
   </sect2>
@@ -611,21 +630,9 @@ Main.skip2{-r1L6-} =
     of platform-specific code that needs to be written in order to get
     unregisterised compilation going is usually fairly small.</para>
 
-    <variablelist>
-      <varlistentry>
-       <term>
-          <option>-unreg</option>:
-          <indexterm><primary><option>-unreg</option></primary></indexterm>
-        </term>
-       <listitem>
-         <para>Compile via vanilla ANSI C only, turning off
-         platform-specific optimisations.  NOTE: in order to use
-         <option>-unreg</option>, you need to have a set of libraries
-         (including the RTS) built for unregisterised compilation.
-         This amounts to building GHC with way "u" enabled.</para>
-       </listitem>
-      </varlistentry>
-    </variablelist>
+   <para>Unregisterised compilation cannot be selected at
+   compile-time; you have to build GHC with the appropriate options
+   set.  Consult the GHC Building Guide for details.</para>
   </sect2>
 
 </sect1>