rust-lang / rust-lang/rustc_public
onboarding friction log
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 125
- Forks
- 19
- PR merge metrics
- No merged PRs in 30d
Description
Logging friction I encountered trying to onboard...
- An example of a working binary that uses
runandrun_with_tcxwould be nice. - The docs didn't make it clear that I should import
use rustc_smir::{run, rustc_internal}. - My function should return
ControlFlow-- what doesContinuevsBreakmean in this context? What type arguments should I give? (I think Continue means "no error" and Break lets me pass back an error value? unclear.) - How do I setup my rust-toolchain.toml file? What is this build.rs I see?
- Why am I getting weird link errors? (cannot satisfy dependencies so
objectonly shows up once) - Where exactly do I need
feature(rustc_private)? On the crate? What if this is a library dependency of another crate?
It'd be really nice to have a simpler entry point, maybe even on crates.io, that automatically compiled to some fallback when nightly is not available.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the onboarding questions about run, run_with_tcx, ControlFlow, rust-toolchain.toml, build.rs, and feature(rustc_private). The issue also requests a working binary example and a simpler crates.io entry point with a nightly fallback; completion criteria and the relevant files are not identified here.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- developer-experience, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100