Document new -L RTS flag
authorIan Lynagh <igloo@earth.li>
Tue, 14 Nov 2006 11:35:42 +0000 (11:35 +0000)
committerIan Lynagh <igloo@earth.li>
Tue, 14 Nov 2006 11:35:42 +0000 (11:35 +0000)
docs/users_guide/profiling.xml

index a88c8bb..c30bd80 100644 (file)
@@ -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>