diff options
| author | Ben Gamari <bgamari.foss@gmail.com> | 2018-11-01 18:31:33 -0400 |
|---|---|---|
| committer | Ben Gamari <ben@smart-cactus.org> | 2018-11-01 18:36:08 -0400 |
| commit | fcd919f991452cc0d42805fca6e549c2efeb0dde (patch) | |
| tree | df0ba7ead73319e55da0ba07093cf119219c3a54 /docs | |
| parent | 614028e3b02a5b71a9fbf9c7028f270760ccdab2 (diff) | |
| download | haskell-fcd919f991452cc0d42805fca6e549c2efeb0dde.tar.gz | |
users-guide: Fix formatting of eventlog format documentation
Test Plan: Read it
Reviewers: mpickering
Reviewed By: mpickering
Subscribers: rwbarton, carter
Differential Revision: https://phabricator.haskell.org/D5264
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/users_guide/eventlog-formats.rst | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/users_guide/eventlog-formats.rst b/docs/users_guide/eventlog-formats.rst index 9910d4dbb0..6fd7d89b7e 100644 --- a/docs/users_guide/eventlog-formats.rst +++ b/docs/users_guide/eventlog-formats.rst @@ -29,6 +29,7 @@ Beginning of sample stream A single fixed-width event emitted during program start-up describing the samples that follow. * ``EVENT_HEAP_PROF_BEGIN`` + * ``Word8``: Profile ID * ``Word64``: Sampling period in nanoseconds * ``Word32``: Sample break-down type. One of, @@ -55,6 +56,7 @@ Cost centre definitions A variable-length packet produced once for each cost centre, * ``EVENT_HEAP_PROF_COST_CENTRE`` + * ``Word32``: cost centre number * ``String``: label * ``String``: module @@ -74,6 +76,7 @@ We mark the beginning of a new sample with an ``EVENT_HEAP_PROF_SAMPLE_BEGIN`` event, * ``EVENT_HEAP_PROF_SAMPLE_BEGIN`` + * ``Word64``: sample number A heap residency census will follow. Since events may only be up to 2^16^ bytes @@ -88,7 +91,9 @@ Cost-centre break-down A variable-length packet encoding a heap profile sample broken down by, * cost-centre (``-hc``) + * ``EVENT_HEAP_PROF_SAMPLE_COST_CENTRE`` + * ``Word8``: Profile ID * ``Word64``: heap residency in bytes * ``Word8``: stack depth @@ -99,11 +104,13 @@ String break-down ^^^^^^^^^^^^^^^^^ A variable-length event encoding a heap sample broken down by, + * type description (``-hy``) * closure description (``-hd``) * module (``-hm``) * ``EVENT_HEAP_PROF_SAMPLE_STRING`` + * ``Word8``: Profile ID * ``Word64``: heap residency in bytes * ``String``: type or closure description, or module name |