rust-lang / rust-lang/rustc_public

onboarding friction log

Open
#88 0 comments 1 reaction 0 assignees View on GitHub

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 run and run_with_tcx would 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 does Continue vs Break mean 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 object only 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

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.