diff options
| author | Ben Gamari <ben@smart-cactus.org> | 2021-09-16 10:20:04 -0400 |
|---|---|---|
| committer | Ben Gamari <ben@smart-cactus.org> | 2021-09-16 10:20:25 -0400 |
| commit | 7a71082d9492efafc959711aa53e4bd4f7161116 (patch) | |
| tree | 608a1d9f2ed794367622ccc3b8d8eff7bf371485 | |
| parent | 64923cf295ea914db458547432237a5ed1eff571 (diff) | |
| download | haskell-wip/ticky-docs.tar.gz | |
users-guide: Improve documentation of ticky eventswip/ticky-docs
| -rw-r--r-- | docs/users_guide/eventlog-formats.rst | 2 | ||||
| -rw-r--r-- | docs/users_guide/profiling.rst | 9 | ||||
| -rw-r--r-- | docs/users_guide/runtime_control.rst | 3 |
3 files changed, 13 insertions, 1 deletions
diff --git a/docs/users_guide/eventlog-formats.rst b/docs/users_guide/eventlog-formats.rst index 6e6c71e1f3..b8ad8f32d9 100644 --- a/docs/users_guide/eventlog-formats.rst +++ b/docs/users_guide/eventlog-formats.rst @@ -901,6 +901,8 @@ heap. Describes the occupancy of the *blk_sz* sub-heap. +.. _ticky-event-format: + Ticky counters ~~~~~~~~~~~~~~ diff --git a/docs/users_guide/profiling.rst b/docs/users_guide/profiling.rst index 4faa437bd8..dbe0da06cf 100644 --- a/docs/users_guide/profiling.rst +++ b/docs/users_guide/profiling.rst @@ -1713,12 +1713,21 @@ Using “ticky-ticky” profiling (for implementors) Track allocations of dynamic thunks. +GHC's ticky-ticky profiler provides a low-level facility for tracking +entry and allocation counts of particular individual closures. Because ticky-ticky profiling requires a certain familiarity with GHC internals, we have moved the documentation to the GHC developers wiki. Take a look at its :ghc-wiki:`overview of the profiling options <commentary/profiling>`, which includes a link to the ticky-ticky profiling page. +Note that ticky-ticky samples can be emitted in two formats: the eventlog, +using the :rts-flag:`-lT <-l ⟨flags⟩>` event type, and a plain text +summary format, using the :rts-flag:`-r ⟨file⟩` option. The former has the +advantage of being able to resolve dynamic behaviors over the program's +lifetime. See :ref:`ticky-event-format` for details on the event types +reported. + .. [1] :ghc-flag:`-fprof-auto` was known as ``-auto-all`` prior to GHC 7.4.1. diff --git a/docs/users_guide/runtime_control.rst b/docs/users_guide/runtime_control.rst index a10a283e52..8f8b9b3fcb 100644 --- a/docs/users_guide/runtime_control.rst +++ b/docs/users_guide/runtime_control.rst @@ -1240,7 +1240,8 @@ When the program is linked with the :ghc-flag:`-eventlog` option - ``f`` — parallel sparks (fully accurate). Disabled by default. - - ``T`` — :ghc-flag:`ticky-ticky profiler <-ticky>` events. Disabled by + - ``T`` — :ghc-flag:`ticky-ticky profiler <-ticky>` events + (see :ref:`ticky-event-format` for details). Disabled by default. - ``u`` — user events. These are events emitted from Haskell code using |