From: simonmar <unknown>
Date: Fri, 6 Jan 2006 11:04:07 +0000 (+0000)
Subject: [project @ 2006-01-06 11:04:07 by simonmar]
X-Git-Tag: final_switch_to_darcs,_this_repo_is_now_live~61
X-Git-Url: http://git.megacz.com/?p=ghc-hetmet.git;a=commitdiff_plain;h=2a2efb720c0fdc06fe749f96f284b00b30f8f3f7

[project @ 2006-01-06 11:04:07 by simonmar]
Document -Rghc-timing
---

diff --git a/ghc/docs/users_guide/flags.xml b/ghc/docs/users_guide/flags.xml
index 8406184..0dde52e 100644
--- a/ghc/docs/users_guide/flags.xml
+++ b/ghc/docs/users_guide/flags.xml
@@ -77,6 +77,12 @@
 	      <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>
+	      <entry>-</entry>
+	    </row>
 	  </tbody>
 	</tgroup>
       </informaltable>
@@ -1876,7 +1882,6 @@ Still to document:
 
 Misc:
   ,  ( "H"                 , HasArg (setHeapSize . fromIntegral . decodeSize) )
-  ,  ( "Rghc-timing"	   , NoArg  (enableTimingStats) )
 
   -Bdir
 -->
diff --git a/ghc/docs/users_guide/using.xml b/ghc/docs/users_guide/using.xml
index 761d6cf..32c194a 100644
--- a/ghc/docs/users_guide/using.xml
+++ b/ghc/docs/users_guide/using.xml
@@ -746,6 +746,19 @@ ghc -c Foo.hs</screen>
 	  it).</para>
 	</listitem>
       </varlistentry>
+
+      <varlistentry>
+        <term><option>-Rghc-timing</option>
+        <indexterm><primary><option>-Rghc-timing</option></primary></indexterm>
+        </term>
+        <listitem>
+          <para>Prints a one-line summary of timing statistics for the
+          GHC run.  This option is equivalent to
+          <literal>+RTS&nbsp;-tstderr</literal>, see <xref
+          linkend="rts-options-gc" />.
+          </para>
+        </listitem>
+      </varlistentry>
     </variablelist>
   </sect1>