First cut at documentation for HPC option in GHC

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

diff --git a/docs/users_guide/flags.xml b/docs/users_guide/flags.xml
index b2c398d..0ef478f 100644 (file)
--- a/docs/users_guide/flags.xml
+++ b/docs/users_guide/flags.xml
@@ -482,6 +482,18 @@
              <entry>-</entry>
            </row>
            <row>
+             <entry><option>-short-ghci-banner</option></entry>
+             <entry>Display a one-line banner at GHCi startup</entry>
+             <entry>dynamic</entry>
+             <entry>-</entry>
+           </row>
+           <row>
+             <entry><option>-long-ghci-banner</option></entry>
+             <entry>Display a full banner at GHCi startup</entry>
+             <entry>dynamic</entry>
+             <entry>-</entry>
+           </row>
+           <row>
              <entry><option>-fdebugging</option></entry>
              <entry>Generate bytecode enabled for debugging</entry>
              <entry>dynamic</entry>
@@ -693,6 +705,12 @@
              <entry><option>-fno-th</option></entry>
            </row>
            <row>
+             <entry><option>-ftype-families</option></entry>
+             <entry>Enable <link linkend="type-families">type families</link>.</entry>
+             <entry>dynamic</entry>
+             <entry><option>-fno-type-families</option></entry>
+           </row>
+           <row>
              <entry><option>-fbang-patterns</option></entry>
              <entry>Enable <link linkend="bang-patterns">bang patterns</link>.</entry>
              <entry>dynamic</entry>
@@ -733,7 +751,7 @@
          </row>
          <row>
            <entry><option>-Wall</option></entry>
-           <entry>enable all warnings</entry>
+           <entry>enable almost all warnings (details in <xref linkend="options-sanity"/>)</entry>
            <entry>dynamic</entry>
            <entry><option>-w</option></entry>
          </row>
@@ -766,6 +784,13 @@
            <entry><option>-fno-warn-hi-shadowing</option></entry>
          </row>
 
+          <row>
+            <entry><option>-fwarn-implicit-prelude</option></entry>
+            <entry>warn when the Prelude is implicitly imported</entry>
+            <entry>dynamic</entry>
+            <entry><option>-fno-warn-implicit-prelude</option></entry>
+          </row>
+
          <row>
            <entry><option>-fwarn-incomplete-patterns</option></entry>
            <entry>warn when a pattern match could fail</entry>
@@ -1050,10 +1075,11 @@
            </row>
 
            <row>
-             <entry><option>-fliberate-case-threshold</option></entry>
-             <entry>Tweak the liberate-case optimisation (default: 10)</entry>
+             <entry><option>-fspec-threshold</option>=<replaceable>n</replaceable></entry>
+             <entry>Set the size threshold for function specialisation to <replaceable>n</replaceable>, for both
+               the liberate-case and SpecConstr transformations (default: 200)</entry>
              <entry>static</entry>
-             <entry><option>-fno-liberate-case-threshold</option></entry>
+             <entry><option>-</option></entry>
            </row>
 
            <row>
@@ -1163,6 +1189,39 @@
     </sect2>
 
     <sect2>
+      <title>Program coverage options</title>
+      
+      <para><xref linkend="hpc"/></para>
+
+      <informaltable>
+       <tgroup cols="4" align="left" colsep="1" rowsep="1">
+         <thead>
+           <row>
+             <entry>Flag</entry>
+             <entry>Description</entry>
+             <entry>Static/Dynamic</entry>
+             <entry>Reverse</entry>
+           </row>
+         </thead>
+         <tbody>
+           <row>
+             <entry><option>-fhpc</option></entry>
+             <entry>Turn on Haskell program coverage instrumentation</entry>
+             <entry>static</entry>
+             <entry><option>-</option></entry>
+           </row>
+           <row>
+             <entry><option>-hpcdir dir</option></entry>
+             <entry>Directory to deposit .mix files during compilation</entry>
+             <entry>dynamic</entry>
+             <entry><option>-</option></entry>
+           </row>
+         </tbody>
+       </tgroup>
+      </informaltable>
+    </sect2>
+
+    <sect2>
       <title>Haskell pre-processor options</title>
 
       <para><xref linkend="pre-processor"/></para>
@@ -1720,6 +1779,12 @@
              <entry>-</entry>
            </row>
            <row>
+             <entry><option>-ddump-hpc</option></entry>
+             <entry>Dump after intrumentation for program coverage</entry>
+             <entry>dynamic</entry>
+             <entry>-</entry>
+           </row>
+           <row>
              <entry><option>-ddump-inlinings</option></entry>
              <entry>Dump inlining info</entry>
              <entry>dynamic</entry>