diff options
| author | Ben Price <ben@brprice.uk> | 2019-01-15 12:38:44 +0000 |
|---|---|---|
| committer | Ben Gamari <ben@smart-cactus.org> | 2019-01-16 14:17:20 -0500 |
| commit | 6acb36d8ea169dfc0ddc4e10559a9bf6b4316212 (patch) | |
| tree | 0050ffc6043f9bb9f6d13c99ba97a7a7b3fc59bc | |
| parent | 61f178b617fcb2c1102b0d0505bb3c70e83c1843 (diff) | |
| download | haskell-6acb36d8ea169dfc0ddc4e10559a9bf6b4316212.tar.gz | |
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.
| -rw-r--r-- | docs/users_guide/profiling.rst | 5 | ||||
| -rw-r--r-- | docs/users_guide/runtime_control.rst | 4 |
2 files changed, 9 insertions, 0 deletions
diff --git a/docs/users_guide/profiling.rst b/docs/users_guide/profiling.rst index def3596393..c1379f3970 100644 --- a/docs/users_guide/profiling.rst +++ b/docs/users_guide/profiling.rst @@ -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 diff --git a/docs/users_guide/runtime_control.rst b/docs/users_guide/runtime_control.rst index 7526b06355..a5c2f1474f 100644 --- a/docs/users_guide/runtime_control.rst +++ b/docs/users_guide/runtime_control.rst @@ -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 |