ghc-events icon indicating copy to clipboard operation
ghc-events copied to clipboard

WIP: Improve haddocks

Open BinderDavid opened this issue 1 year ago • 5 comments

BinderDavid avatar Jun 09 '23 14:06 BinderDavid

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.

Mikolaj avatar Jun 09 '23 14:06 Mikolaj

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.

BinderDavid avatar Jun 09 '23 14:06 BinderDavid

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 avatar Jun 09 '23 14:06 Mikolaj

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

Mikolaj avatar Apr 16 '24 09:04 Mikolaj

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.

BinderDavid avatar Apr 17 '24 14:04 BinderDavid