Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: Improve haddocks #98

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

BinderDavid
Copy link
Contributor

No description provided.

@Mikolaj
Copy link
Member

Mikolaj commented Jun 9, 2023

I'm not the current maintainer, but thanks a lot, buddy, great job this and the other PRs!

BTW, I think there may be some old docs somewhere. If not in this repo, perhaps in the ThreadScope repo or in some writeup about the RTS? I may be misremembering, though.

@BinderDavid
Copy link
Contributor Author

Yep, I am sitting here at the GHC Contributor workshop and plan on working a bit on this on the weekend. I found it very difficult to figure out what all the events mean, apparently even some GHC devs are a bit confused on the details: https://gitlab.haskell.org/ghc/ghc/-/issues/23105 :) I plan to simultaneously also work on improving the documentation in the GHC User guide, since the documentation there is also incomplete and contains various TODOs.

@Mikolaj
Copy link
Member

Mikolaj commented Jun 9, 2023

Oh cool. Yeah, the semantics is complex. ThreadScope contains some finite automata where the states are the events, but unfortunately most are jail-broken (illegal state transitions are accepted), because the RTS semantics is full of exceptions (or events sometimes get serialized out of order, I never managed to figure out which it is).

@Mikolaj
Copy link
Member

Mikolaj commented Apr 16, 2024

@BinderDavid: how is it going with the GHC User guide? Anything to port to ghc-events already?

@BinderDavid
Copy link
Contributor Author

Sorry, I somehow got a bit distracted. I can see if I find time this weekend to at least bring this PR in a mergeable state.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants