Update StableMIR doc to reflect current status #132085
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
We no longer use git subtree, and we have 2 different crates.
rustbot
added
S-waiting-on-review
compiler-errors
requested changes
Oct 24, 2024
compiler/stable_mir/README.md
Outdated
|
|
||
| Then open a PR against rustc just like a regular PR. | ||
| Our goal is to start publishing `stable_mir` into crates.io. | ||
| Until then, users will use this as any other rustc crate, via extern crate. |
There was a problem hiding this comment.
Perhaps mention that users need to install the rustc-dev component.
|
|
||
| ## Stable MIR Design | ||
|
|
||
| The stable-mir will follow a similar approach to proc-macro2. It’s | ||
| implementation will eventually be broken down into two main crates: | ||
| implementation is done using two main crates: | ||
|
|
||
| - `stable_mir`: Public crate, to be published on crates.io, which will contain |
There was a problem hiding this comment.
- `stable_mir`: Public crate, to be published on crates.io, whics contains
the stable data structures and APIs to access them. It calls to `rustc_smir`.
- `rustc_smir`: This crate serves as `stable_mir`'s interface to the compiler.
It is responsible for gathering all the information requested, and converting
them to their stable data structures.
There was a problem hiding this comment.
Github didn't allow me to rewrite this as an inline suggestion, but this section seems wrong. AFAICT, the rustc_smir crate is what does the conversion; hence it having all the .stable calls.
There was a problem hiding this comment.
Indeed. Not for long though, but I'll update this to match the current state. Thanks
There was a problem hiding this comment.
I documented that we are in a transition period. Let me know if that makes sense.
|
Anyways r=me after tweaking unless you specifically want a review from scott |
Co-authored-by: Michael Goulet <michael@errs.io>
Clarify that the translation between unstable and stable items is currently done in the `rustc_smir` crate.
|
@compiler-errors do you mind taking a quick look at the updated version? Thanks |
compiler-errors
approved these changes
Oct 25, 2024
|
@bors r+ rollup |
bors
added
S-waiting-on-bors
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Oct 25, 2024
…kingjubilee Rollup of 4 pull requests Successful merges: - rust-lang#131457 (Expand `ptr::fn_addr_eq()` documentation.) - rust-lang#132085 (Update StableMIR doc to reflect current status) - rust-lang#132118 (Add support for `~const` item bounds) - rust-lang#132125 (coverage: Emit LLVM intrinsics using the normal helper method) r? `@ghost` `@rustbot` modify labels: rollup
rust-timer
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Oct 25, 2024
Rollup merge of rust-lang#132085 - celinval:update-smir-doc, r=compiler-errors Update StableMIR doc to reflect current status Update stable-mir documentation, since we no longer use git subtree, and we have 2 different crates.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Update stable-mir documentation, since we no longer use git subtree, and we have 2 different crates.