summaryrefslogtreecommitdiff
path: root/docs/users_guide/profiling.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/users_guide/profiling.rst')
-rw-r--r--docs/users_guide/profiling.rst9
1 files changed, 9 insertions, 0 deletions
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.