Docs: Improve the BGV docs a bit

Shopify / seafoam

A tool for working with compiler graphs dumped by the GraalVM compiler

MIT License

126 stars 22 forks source link

Docs: Improve the BGV docs a bit #46

Closed mattco98 closed 2 years ago

mattco98 commented 2 years ago

Hello! I made a little .bgv file reader/writer originally for use with IGV, but then I stumbled across this repo, and bgv.md. The file was very helpful in giving me a general overview of the file format, something which would have been very hard from just looking at GraalVM's GraphProtocol directly. As I developed my tool I realized there were some errors and inconsistencies in the file which I fixed, so I figured I'd upstream the changes.

olekslitus commented 2 years ago

@mattco98 Thank you for the improvements. Have you published your reader/writer?

mattco98 commented 2 years ago

Yeah, I started it but lost motivation to work on the project I needed it for. I'll probably continue it at some point in the future.

olekslitus commented 2 years ago

@mattco98 Thank you for the link, I will take a look, maybe try to dot something similar in Python.