Update to manual section for ticky-ticky

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

diff --git a/docs/users_guide/profiling.xml b/docs/users_guide/profiling.xml
index a88c8bb..fb6049d 100644 (file)
--- a/docs/users_guide/profiling.xml
+++ b/docs/users_guide/profiling.xml
@@ -710,7 +710,7 @@ x = nfib 25
       currently support mixing the <option>-hr</option> and
       <option>-hb</option> options.</para>
 
-      <para>There are two more options which relate to heap
+      <para>There are three more options which relate to heap
       profiling:</para>
 
       <variablelist>
@@ -750,6 +750,19 @@ x = nfib 25
            by closure description or type description.</para>
          </listitem>
        </varlistentry>
+
+       <varlistentry>
+         <term>
+            <option>-L<replaceable>num</replaceable></option>
+            <indexterm><primary><option>-L</option></primary><secondary>RTS option</secondary></indexterm>
+          </term>
+         <listitem>
+           <para>
+          Sets the maximum length of a cost-centre stack name in a
+          heap profile. Defaults to 25.
+           </para>
+         </listitem>
+       </varlistentry>
       </variablelist>
 
     </sect2>
@@ -1314,9 +1327,9 @@ to re-read its input file:
     profiling system, intended for all users everywhere.</para>
 
     <para>To be able to use ticky-ticky profiling, you will need to
-    have built appropriate libraries and things when you made the
-    system.  See &ldquo;Customising what libraries to build,&rdquo; in
-    the installation guide.</para>
+    have built the ticky RTS. (This should be described in 
+    the building guide, but amounts to building the RTS with way
+    "t" enabled.)</para>
 
     <para>To get your compiled program to spit out the ticky-ticky
     numbers, use a <option>-r</option> RTS