summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAdam Sandberg Ericsson <adam@sandbergericsson.se>2023-03-11 21:03:14 +0000
committerMarge Bot <ben+marge-bot@smart-cactus.org>2023-03-21 11:17:53 -0400
commit90159773f1aeaf52d7ac3ba82d21c0f92c86ea15 (patch)
tree171332936a2387c23ee92cab7f81b9fac907bace /docs
parent23642bf609a5da928992b4fae9242194f848ff2f (diff)
downloadhaskell-90159773f1aeaf52d7ac3ba82d21c0f92c86ea15.tar.gz
docs: explain the BLOCK_MARKER event
Diffstat (limited to 'docs')
-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