diff options
| author | Matthew Pickering <matthewtpickering@gmail.com> | 2020-12-21 08:59:27 +0000 |
|---|---|---|
| committer | Marge Bot <ben+marge-bot@smart-cactus.org> | 2021-01-27 17:38:32 -0500 |
| commit | 925738839891b320b9436e7383d55dce2b8d4543 (patch) | |
| tree | 23b1eff30fedebfabb827193ac5259a06a13ef6b /docs/users_guide | |
| parent | 34a8a0e4cf188a30d2b4b65909f24185c80d071e (diff) | |
| download | haskell-925738839891b320b9436e7383d55dce2b8d4543.tar.gz | |
Deprecate -h flag
It is confusing that it defaults to two different things depending on
whether we are in the profiling way or not.
Use -hc if you have a profiling build
Use -hT if you have a normal build
Fixes #19031
Diffstat (limited to 'docs/users_guide')
| -rw-r--r-- | docs/users_guide/9.2.1-notes.rst | 3 | ||||
| -rw-r--r-- | docs/users_guide/profiling.rst | 5 |
2 files changed, 6 insertions, 2 deletions
diff --git a/docs/users_guide/9.2.1-notes.rst b/docs/users_guide/9.2.1-notes.rst index 6a2cc96128..717da75c33 100644 --- a/docs/users_guide/9.2.1-notes.rst +++ b/docs/users_guide/9.2.1-notes.rst @@ -85,6 +85,9 @@ Runtime system space lost to fragmentation is no longer counted as live data. +- The :rts-flag:`-h` flag has been deprecated, use either :rts-flag:`-hc` or + :rts-flag:`-hT` explicitly, as appropiate. + ``ghc-prim`` library ~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/users_guide/profiling.rst b/docs/users_guide/profiling.rst index ac1137ac84..62b5615aed 100644 --- a/docs/users_guide/profiling.rst +++ b/docs/users_guide/profiling.rst @@ -724,7 +724,7 @@ To generate a heap profile from your program: 1. Compile the program for profiling (:ref:`prof-compiler-options`). 2. Run it with one of the heap profiling options described below (eg. - :rts-flag:`-h` for a basic producer profile). This generates the file + :rts-flag:`-hc` for a basic producer profile). This generates the file :file:`{prog}.hp`. If the :ref:`event log <rts-eventlog>` is enabled (with the :rts-flag:`-l ⟨flags⟩` @@ -769,7 +769,8 @@ following RTS options select which break-down to use: .. 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`). + equivalent to :rts-flag:`-hT` (see :ref:`rts-profiling`). The :rts-flag:`-h` + is deprecated and will be removed in a future release. .. rts-flag:: -hm |