diff options
| author | Ian Lynagh <igloo@earth.li> | 2008-11-30 15:23:11 +0000 |
|---|---|---|
| committer | Ian Lynagh <igloo@earth.li> | 2008-11-30 15:23:11 +0000 |
| commit | 7eb7ed723e9afbb2df4087108d07db5fbc47e7e1 (patch) | |
| tree | e9e07c9fe6c67900f369232355d54524910569aa /docs | |
| parent | 854afa17c0588b2b1a238a5c9e572bc9ad07bcf0 (diff) | |
| download | haskell-7eb7ed723e9afbb2df4087108d07db5fbc47e7e1.tar.gz | |
Document the --machine-readable RTS flag
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/users_guide/runtime_control.xml | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/users_guide/runtime_control.xml b/docs/users_guide/runtime_control.xml index e0dd420cab..94995b3e8d 100644 --- a/docs/users_guide/runtime_control.xml +++ b/docs/users_guide/runtime_control.xml @@ -477,6 +477,10 @@ <option>-S</option><optional><replaceable>file</replaceable></optional> <indexterm><primary><option>-S</option></primary><secondary>RTS option</secondary></indexterm> </term> + <term> + <option>--machine-readable</option> + <indexterm><primary><option>--machine-readable</option></primary><secondary>RTS option</secondary></indexterm> + </term> <listitem> <para>These options produce runtime-system statistics, such as the amount of time spent executing the program and in the @@ -543,6 +547,27 @@ </itemizedlist> <para> + You can also get this in a more future-proof, machine readable + format, with <literal>-t --machine-readable</literal>: + </para> + +<programlisting> + [("bytes allocated", "36169392") + ,("num_GCs", "69") + ,("average_bytes_used", "603392") + ,("max_bytes_used", "1065272") + ,("num_byte_usage_samples", "2") + ,("peak_megabytes_allocated", "3") + ,("init_cpu_seconds", "0.00") + ,("init_wall_seconds", "0.00") + ,("mutator_cpu_seconds", "0.02") + ,("mutator_wall_seconds", "0.02") + ,("GC_cpu_seconds", "0.07") + ,("GC_wall_seconds", "0.07") + ] +</programlisting> + + <para> If you use the <literal>-s</literal> flag then, when your program finishes, you will see something like this (the exact details will vary depending on what sort of RTS you have, e.g. |