diff options
| author | Adam Sandberg Eriksson <adam@sandbergericsson.se> | 2019-08-01 16:18:16 +0200 |
|---|---|---|
| committer | Marge Bot <ben+marge-bot@smart-cactus.org> | 2019-08-02 08:16:45 -0400 |
| commit | 5e960287b74ce2e11be98dbf7c1dc4ce2d7e0d9a (patch) | |
| tree | 63027bc92b6c4ebced19499f843f7231d64c3f2c /docs | |
| parent | c902f56b7f7b79d8b7480895c2236106578fbd4d (diff) | |
| download | haskell-5e960287b74ce2e11be98dbf7c1dc4ce2d7e0d9a.tar.gz | |
docs: fixs -prof links in rts-flags section
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/users_guide/profiling.rst | 13 |
1 files changed, 6 insertions, 7 deletions
diff --git a/docs/users_guide/profiling.rst b/docs/users_guide/profiling.rst index 1dfe7dd7b0..1a083eb711 100644 --- a/docs/users_guide/profiling.rst +++ b/docs/users_guide/profiling.rst @@ -694,7 +694,7 @@ following RTS options select which break-down to use: .. rts-flag:: -hc -h - *Requires :ghc-flag:`-prof`.* Breaks down the graph by the cost-centre stack + *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 @@ -704,34 +704,33 @@ following RTS options select which break-down to use: .. rts-flag:: -hm - *Requires :ghc-flag:`-prof`.* Break down the live heap by the module + *Requires* :ghc-flag:`-prof`. Break down the live heap by the module containing the code which produced the data. .. rts-flag:: -hd - *Requires :ghc-flag:`-prof`.* Breaks down the graph by closure description. + *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 - *Requires :ghc-flag:`-prof`.* Breaks down the graph by type. For closures + *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 - *Requires :ghc-flag:`-prof`.* Break down the graph by retainer set. Retainer + *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 - *Requires :ghc-flag:`-prof`.* Break down the graph by biography. + *Requires* :ghc-flag:`-prof`. Break down the graph by biography. Biographical profiling is described in more detail below (:ref:`biography-prof`). .. rts-flag:: -l - :noindex: .. index:: |