summaryrefslogtreecommitdiff
path: root/docs/users_guide/runtime_control.rst
diff options
context:
space:
mode:
authorBen Gamari <ben@smart-cactus.org>2016-01-23 22:03:04 +0100
committerBen Gamari <ben@smart-cactus.org>2016-01-23 22:50:07 +0100
commit923d2151db261cac36577bcaffa6be41c3f374f9 (patch)
tree2403fb1864431a564fe8393f8c8848412abeeb2f /docs/users_guide/runtime_control.rst
parentec8778862aeb9c3f6b861bc732045db9f58b9b61 (diff)
downloadhaskell-923d2151db261cac36577bcaffa6be41c3f374f9.tar.gz
user-guide: Document -L RTS flag
See #5641.
Diffstat (limited to 'docs/users_guide/runtime_control.rst')
-rw-r--r--docs/users_guide/runtime_control.rst19
1 files changed, 12 insertions, 7 deletions
diff --git a/docs/users_guide/runtime_control.rst b/docs/users_guide/runtime_control.rst
index db983fa8e8..7c4159a4b6 100644
--- a/docs/users_guide/runtime_control.rst
+++ b/docs/users_guide/runtime_control.rst
@@ -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: