Commit 923d2151 authored by Ben Gamari's avatar Ben Gamari 🐢
Browse files

user-guide: Document -L RTS flag

See #5641.
parent ec877886
......@@ -797,13 +797,18 @@ executables:
.. rts-flag:: -hT
(can be shortened to ``-h``.) Generates a basic heap profile, in the
file :file:`prog.hp`. To produce the heap profile graph, use :command:`hp2ps`
(see :ref:`hp2ps`). The basic heap profile is broken down by data
constructor, with other types of closures (functions, thunks, etc.)
grouped into broad categories (e.g. ``FUN``, ``THUNK``). To get a
more detailed profile, use the full profiling support
(:ref:`profiling`).
Generates a basic heap profile, in the file :file:`prog.hp`. To produce the
heap profile graph, use :command:`hp2ps` (see :ref:`hp2ps`). The basic heap
profile is broken down by data constructor, with other types of closures
(functions, thunks, etc.) grouped into broad categories (e.g. ``FUN``,
``THUNK``). To get a more detailed profile, use the full profiling support
(:ref:`profiling`). Can be shortened to ``-h``.
.. rts-flag:: -L <n>
:default: 25 characters
Sets the maximum length of the cost-centre names listed in the heap profile.
.. _rts-eventlog:
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment