Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
this PR does 2 things:
it reworks the way our IR is conveyed so that the protobuf holds as much info on instruction/type structure as possible. the gist of the issue is outlined in proto spec doesnt convey instruction structure #52, but there were a bunch of other places i found the same issues outside of just
Instruction
. now instead of relying on partially filled structs and enums it uses the properoneof
keyword to generate the correct structures. Not only does this make our provided IR implementation much easier to work with/understand, it also eliminated the need to do any complex decoding of the protobuf inside the IR.this pr adds a bytecode spec! this is achieved by adding comments to the
.proto
files then using the repo protoc-gen-doc to automatically generate documentation from it.a bug currently exists in protoc-gen-doc that makes generating markdown files annoying as detailed in #65
closes #36 and #52