-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Add link to Cranelift Examples #10912
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
Conversation
cfallin
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the PR and for putting together these examples! A suggested change to wording below but otherwise I'm happy to see this merged in.
cranelift/README.md
Outdated
| [Wasmtime]: https://github.com/bytecodealliance/wasmtime | ||
|
|
||
| For various examples of how to use Cranelift to accomplish common compiler | ||
| tasks, see the [Cranelift Examples] repository. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's make this a little more explicit about the third-party maintenance -- perhaps something like "For various examples of how to use Cranelift to accomplish common compiler tasks, in addition to the above, @simvux maintains a [Cranelift Examples] repository." ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good point!
Although not sure about the wording. "in addition to above" could be misinterpreted as me maintaining the JIT demo.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, sure, I had just meant to indicate that it's another set of examples, but no need for that phrase I suppose.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about just
For various examples of how to use Cranelift to accomplish common compiler
tasks, see the [Cranelift Examples] repository maintained by @simvux.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sounds good!
cfallin
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
|
Thanks @simvux for helping show more folks how to use cranelift. If your project grows to have more contributors and you'd like to contribute these examples to the bytecode alliance, you could consider making a proposal in bytecodealliance/governance (like this one) to shift the project over here and make it more official. The most important bar to reach there, in my opinion, is the requirement for a |
* Add link to Cranelift Examples * clarify that Cranelift Examples is third-party maintained
#cranelift > Cranelift Examples Repository
cranelift-examples is an attempt at documenting the various (often higher-level) questions people tend to have when learning to use Cranelift as a compiler backend. The goal is to have examples that address very specific topics in a predictable format with lots of comments that not only explain what the Cranelift code does, but also explains the topic more broadly.