AnnieSld opened PR #13809 from AnnieSld:cranelift-modernize-docs to bytecodealliance:main:
<!--
Please make sure you include the following information:
If this work has been discussed elsewhere, please include a link to that
conversation. If it was discussed in an issue, just mention "issue #...".Explain why this change is needed. If the details are in an issue already,
this can be brief.Our development process is documented in the Wasmtime book:
https://docs.wasmtime.dev/contributing-development-process.htmlPlease ensure all communication follows the code of conduct:
https://github.com/bytecodealliance/wasmtime/blob/main/CODE_OF_CONDUCT.md
-->I'm reopening this as a new, smaller PR.
This PR contains only the changes I verified against the current codebase:
- cranelift/docs/testing.md: removed test commands that no longer exist in cranelift/filetests/src/ (test legalizer, test regalloc, test simple-gvn, test licm, test dce, test shrink, test simple_preopt). Also, updated outdated file paths referencing the old cranelift-codegen/meta-python/ structure, and replaced broken Sphinx syntax with standard Markdown.
- cranelift/docs/add-clif-instruction.md: new guide documenting how to add a new opcode to CLIF, verified against cranelift/codegen/meta/src/shared/instructions.rs.
- cranelift/docs/isle-integration.md: updated a paragraph about move mitosis that stated regalloc2 was a future migration; regalloc2 is already integrated in the current codebase.
Addresses #4135
AnnieSld requested alexcrichton for a review on PR #13809.
AnnieSld requested wasmtime-compiler-reviewers for a review on PR #13809.
github-actions[bot] added the label cranelift on PR #13809.
github-actions[bot] added the label cranelift:docs on PR #13809.
:thumbs_up: alexcrichton submitted PR review:
Thanks!
:speech_balloon: alexcrichton created PR review comment:
This last clause, an explicit "unsupported" case, is unnecessary because that's the default if no other rule happens to match. Basically it's fine to do nothing for unsupported backends when adding a new instruction
:memo: bjorn3 submitted PR review.
:speech_balloon: bjorn3 created PR review comment:
Should the above docs be updated to alos remove the references to "move mitosis"?
:speech_balloon: bjorn3 created PR review comment:
`cranelift/codegen/meta/src/isa/<arch>.rs`.
:memo: bjorn3 submitted PR review.
AnnieSld updated PR #13809.
:memo: AnnieSld submitted PR review.
:speech_balloon: AnnieSld created PR review comment:
Thanks for the clarification! I'll remove that sentence.
AnnieSld updated PR #13809.
:memo: AnnieSld submitted PR review.
:speech_balloon: AnnieSld created PR review comment:
Thanks! I'll remove the references to move mitosis here as well.
AnnieSld updated PR #13809.
alexcrichton added PR #13809 Cranelift modernize docs to the merge queue.
:check: alexcrichton merged PR #13809.
alexcrichton removed PR #13809 Cranelift modernize docs from the merge queue.
Last updated: Jul 29 2026 at 05:03 UTC