diff options
| author | Adam Sandberg Ericsson <adam@sandbergericsson.se> | 2022-03-23 17:19:00 +0000 |
|---|---|---|
| committer | Marge Bot <ben+marge-bot@smart-cactus.org> | 2022-03-28 01:18:31 -0400 |
| commit | 4aeade157474ae379466343b00920bbcc0bfa628 (patch) | |
| tree | a69e1fa1b4dde0f13a64ab550b31a2e9d0055817 | |
| parent | 12653be933aa2c6d337f006a62f2d41bd584e7a4 (diff) | |
| download | haskell-4aeade157474ae379466343b00920bbcc0bfa628.tar.gz | |
users-guide: group ticky-ticky profiling under one heading
| -rw-r--r-- | docs/users_guide/profiling.rst | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/users_guide/profiling.rst b/docs/users_guide/profiling.rst index 22ca43466c..0ae4b39450 100644 --- a/docs/users_guide/profiling.rst +++ b/docs/users_guide/profiling.rst @@ -1752,7 +1752,7 @@ Getting started with ticky profiling consists of three steps. ticked throughout the duration of the program. Additional Ticky Flags ----------------------- +~~~~~~~~~~~~~~~~~~~~~~ There are some additional flags which can be used to increase the number of ticky counters and the quality of the profile. @@ -1821,7 +1821,7 @@ lifetime. See :ref:`ticky-event-format` for details on the event types reported. Understanding the Output of Ticky-Ticky profiles ------------------------------------------------- +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Once you have your rendered profile then you can begin to understand the allocation behaviour of your program. There are two classes of ticky-ticky counters. @@ -1842,7 +1842,7 @@ In general you are probably interested mostly in the name-specific counters as t can provided detailed information about where allocates how much in your program. Information about name-specific counters ----------------------------------------- +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Name-specific counters provide the following information about a closure. @@ -1889,7 +1889,7 @@ calls to dictionary arguments by searching the profile for the ``+`` classifier. This indicates that the function has failed to specialise for one reason or another. Examples --------- +~~~~~~~~ A typical use of ticky-ticky would be to generate a ticky report using the eventlog by evoking an application with RTS arguments like this: @@ -1905,7 +1905,7 @@ on the produced eventlog. In the example above the invocation would then be ``ev Which will produce a searchable and sortable table containing all the ticky counters in the log. Notes about ticky profiling ---------------------------- +~~~~~~~~~~~~~~~~~~~~~~~~~~~ * You can mix together modules compiled with and without ``-ticky`` but you will miss out on allocations and counts from uninstrumented modules in the profile. |