From e7bb988089e35d38f661c1527696bf72e18e20db Mon Sep 17 00:00:00 2001
From: "Edward Z. Yang" <ezyang@mit.edu>
Date: Tue, 17 Jan 2012 23:55:53 -0500
Subject: [PATCH] Document -T RTS flag in manual.
Signed-off-by: Edward Z. Yang <ezyang@mit.edu>
---
docs/users_guide/runtime_control.xml | 11 +++++++++++
1 file changed, 11 insertions(+)
diff --git a/docs/users_guide/runtime_control.xml b/docs/users_guide/runtime_control.xml
index 7b2b469a0a14..5870092c2b54 100644
--- a/docs/users_guide/runtime_control.xml
+++ b/docs/users_guide/runtime_control.xml
@@ -729,6 +729,10 @@ $ ./prog -f +RTS -H32m -S -RTS -h foo bar
</varlistentry>
<varlistentry>
+ <term>
+ <option>-T</option>
+ <indexterm><primary><option>-T</option></primary><secondary>RTS option</secondary></indexterm>
+ </term>
<term>
<option>-t</option><optional><replaceable>file</replaceable></optional>
<indexterm><primary><option>-t</option></primary><secondary>RTS option</secondary></indexterm>
@@ -751,6 +755,7 @@ $ ./prog -f +RTS -H32m -S -RTS -h foo bar
garbage collector, the amount of memory allocated, the
maximum size of the heap, and so on. The three
variants give different levels of detail:
+ <option>-T</option> collects the data but produces no output
<option>-t</option> produces a single line of output in the
same format as GHC's <option>-Rghc-timing</option> option,
<option>-s</option> produces a more detailed summary at the
@@ -763,6 +768,12 @@ $ ./prog -f +RTS -H32m -S -RTS -h foo bar
<replaceable>file</replaceable> is omitted, then the output
is sent to <constant>stderr</constant>.</para>
+ <para>
+ If you use the <literal>-T</literal> flag then, you should
+ access the statistics using
+ <ulink url="&libraryBaseLocation;/GHC-Stats.html">GHC.Stats</ulink>.
+ </para>
+
<para>
If you use the <literal>-t</literal> flag then, when your
program finishes, you will see something like this:
--
GitLab