[commit: ghc] master: user-guide: Document -L RTS flag (923d215)

[git at git.haskell.org]

Repository : ssh://git@git.haskell.org/ghc

On branch  : master
Link       : http://ghc.haskell.org/trac/ghc/changeset/923d2151db261cac36577bcaffa6be41c3f374f9/ghc

>---------------------------------------------------------------

commit 923d2151db261cac36577bcaffa6be41c3f374f9
Author: Ben Gamari <ben at smart-cactus.org>
Date:   Sat Jan 23 22:03:04 2016 +0100

    user-guide: Document -L RTS flag
    
    See #5641.


>---------------------------------------------------------------

923d2151db261cac36577bcaffa6be41c3f374f9
 docs/users_guide/runtime_control.rst | 19 ++++++++++++-------
 1 file changed, 12 insertions(+), 7 deletions(-)

diff --git a/docs/users_guide/runtime_control.rst b/docs/users_guide/runtime_control.rst
index db983fa..7c4159a 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: