diff options
| author | Ben Gamari <bgamari.foss@gmail.com> | 2017-09-04 08:14:38 -0400 |
|---|---|---|
| committer | Ben Gamari <ben@smart-cactus.org> | 2017-09-05 07:20:01 -0400 |
| commit | 822abbb1b4300ebaa3f12014b9fc477261283143 (patch) | |
| tree | 2914b75c08af6713f3775d5d0eadd48bc10a3e9b /docs/users_guide/profiling.rst | |
| parent | c2881a23319d91c6e1301a6fd149ca37a3bcfc1e (diff) | |
| download | haskell-822abbb1b4300ebaa3f12014b9fc477261283143.tar.gz | |
eventlog: Clean up profiling heap breakdown type
Reviewers: austin, erikd, simonmar
Subscribers: rwbarton, thomie
GHC Trac Issues: #14096
Differential Revision: https://phabricator.haskell.org/D3923
Diffstat (limited to 'docs/users_guide/profiling.rst')
| -rw-r--r-- | docs/users_guide/profiling.rst | 29 |
1 files changed, 15 insertions, 14 deletions
diff --git a/docs/users_guide/profiling.rst b/docs/users_guide/profiling.rst index ded667581f..589fbdbded 100644 --- a/docs/users_guide/profiling.rst +++ b/docs/users_guide/profiling.rst @@ -690,35 +690,36 @@ following RTS options select which break-down to use: .. rts-flag:: -hc -h - (can be shortened to :rts-flag:`-h`). Breaks down the graph by the - cost-centre stack which produced the data. + *Requires :ghc-flag:`-prof`.* Breaks down the graph by the cost-centre stack + which produced the data. .. rts-flag:: -hm - Break down the live heap by the module containing the code which - produced the data. + *Requires :ghc-flag:`-prof`.* Break down the live heap by the module + containing the code which produced the data. .. rts-flag:: -hd - Breaks down the graph by closure description. For actual data, the - description is just the constructor name, for other closures it is a - compiler-generated string identifying the closure. + *Requires :ghc-flag:`-prof`.* Breaks down the graph by closure description. + For actual data, the description is just the constructor name, for other + closures it is a compiler-generated string identifying the closure. .. rts-flag:: -hy - Breaks down the graph by type. For closures which have function type - or unknown/polymorphic type, the string will represent an - approximation to the actual type. + *Requires :ghc-flag:`-prof`.* Breaks down the graph by type. For closures + which have function type or unknown/polymorphic type, the string will + represent an approximation to the actual type. .. rts-flag:: -hr - Break down the graph by retainer set. Retainer profiling is - described in more detail below (:ref:`retainer-prof`). + *Requires :ghc-flag:`-prof`.* Break down the graph by retainer set. Retainer + profiling is described in more detail below (:ref:`retainer-prof`). .. rts-flag:: -hb - Break down the graph by biography. Biographical profiling is - described in more detail below (:ref:`biography-prof`). + *Requires :ghc-flag:`-prof`.* Break down the graph by biography. + Biographical profiling is described in more detail below + (:ref:`biography-prof`). .. rts-flag:: -l |