[Git][ghc/ghc][wip/adamse/eventlog-docs] docs: explain the BLOCK_MARKER event

[ase (@adamse)]

ase pushed to branch wip/adamse/eventlog-docs at Glasgow Haskell Compiler / GHC


Commits:
70ebd2b7 by Adam Sandberg Ericsson at 2023-03-11T21:03:14+00:00
docs: explain the BLOCK_MARKER event

- - - - -


1 changed file:

- docs/users_guide/eventlog-formats.rst


Changes:

=====================================
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 the events that fit in the next ``block size``
+   bytes all belong to the block marker capability.
 
 .. event-type:: USER_MSG
 



View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/70ebd2b731677194883e20319ce9b66c8a829f91

-- 
View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/70ebd2b731677194883e20319ce9b66c8a829f91
You're receiving this email because of your account on gitlab.haskell.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.haskell.org/pipermail/ghc-commits/attachments/20230311/bad9820f/attachment.html>