summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAdam Sandberg Ericsson <adam@sandbergericsson.se>2023-03-11 21:03:14 +0000
committerAdam Sandberg Ericsson <adam@sandbergericsson.se>2023-03-20 16:25:11 +0000
commit5e40c42dee42cd2c02116b454e5731edf020cbbc (patch)
tree7b28b4f07c3319868c3b8c0b658806bc11a049a1
parent72cabc8afa8266dd561d3b96fc00f120775a9b02 (diff)
downloadhaskell-5e40c42dee42cd2c02116b454e5731edf020cbbc.tar.gz
docs: explain the BLOCK_MARKER event
-rw-r--r--docs/users_guide/eventlog-formats.rst7
1 files changed, 4 insertions, 3 deletions
diff --git a/docs/users_guide/eventlog-formats.rst b/docs/users_guide/eventlog-formats.rst
index dae6de4a84..4d28e1737b 100644
--- a/docs/users_guide/eventlog-formats.rst
+++ b/docs/users_guide/eventlog-formats.rst
@@ -553,11 +553,12 @@ Tracing events
:tag: 18
:length: fixed
- :field Word32: size
+ :field Word32: block size
:field Word64: end time in nanoseconds
- :field Word16: capability number
+ :field Word16: capability number, invalid if ``0xffff``.
- TODO
+ Marks a chunk of events. The events that fit in the next ``block size``
+ bytes all belong to the block marker capability.
.. event-type:: USER_MSG