Commit 6acb36d8 authored by Ben Price's avatar Ben Price Committed by Ben Gamari

doc: behaviour of +RTS -h depends on profiling

The rts option `-h` behaves as `-hT` when compiled without profiling,
and `-hc` when compiled with profiling. Add a note to the user's guide
highlighting this inconsistency.
parent 61f178b6
......@@ -697,6 +697,11 @@ following RTS options select which break-down to use:
*Requires :ghc-flag:`-prof`.* Breaks down the graph by the cost-centre stack
which produced the data.
.. note:: The meaning of the shortened :rts-flag:`-h` is dependent on whether
your program was compiled for profiling. When compiled for profiling,
:rts-flag:`-h` is equivalent to :rts-flag:`-hc`, but otherwise is
equivalent to :rts-flag:`-hT` (see :ref:`rts-profiling`).
.. rts-flag:: -hm
*Requires :ghc-flag:`-prof`.* Break down the live heap by the module
......
......@@ -984,6 +984,10 @@ executables:
``THUNK``). To get a more detailed profile, use the full profiling support
(:ref:`profiling`). Can be shortened to :rts-flag:`-h`.
.. note:: The meaning of the shortened :rts-flag:`-h` is dependent on whether
your program was compiled for profiling.
(See :ref:`rts-options-heap-prof` for details.)
.. rts-flag:: -L ⟨n⟩
:default: 25 characters
......
Markdown is supported
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