Document rustc_public lib.rs and update README by celinval · Pull Request #159347 · rust-lang/rust

celinval · 2026-07-15T17:02:19Z

Add module-level documentation with usage example, crate discovery guide, and status section. Document all public types, methods, and free functions in lib.rs. Update README to reflect the crate rename from stable_mir/rustc_smir to rustc_public/rustc_public_bridge.

Disclaimer: I used AI to help me generate the documentation.

Add module-level documentation with usage example, crate discovery guide, and status section. Document all public types, methods, and free functions in lib.rs. Update README to reflect the crate rename from stable_mir/rustc_smir to rustc_public/rustc_public_bridge.

rustbot · 2026-07-15T17:02:22Z

This PR changes rustc_public

cc @oli-obk, @ouz-a, @makai410

rustbot · 2026-07-15T17:02:24Z

r? @scottmcm

rustbot has assigned @scottmcm.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

Why was this reviewer chosen?

The reviewer was selected based on:

Owners of files modified in this PR: project-rustc-public
project-rustc-public expanded to celinval, makai410, oli-obk, scottmcm
Random selection from makai410, oli-obk, scottmcm

mejrs · 2026-07-15T21:18:28Z

 pub mod ty;
 pub mod visitor;

-/// Use String for now but we should replace it.


Does this no longer need replacing? It reads like it should be a FIXME

View changes since the review

true... let me expand this. I was actually thinking of changing it to be an opaque type for now. But I didn't want to change it as part of this PR.

mejrs · 2026-07-15T22:11:52Z

+    /// Returns `true` if this item, or any of its parent definitions, has type
+    /// or const generic parameters. This applies to functions, constants, statics,
+    /// and any item nested inside a generic context.


What is a parent definition precisely?🤔

I'd say a parent definition is the DefId of the enclosing item of this item, and this item inherits the enclosing item's generic parameters.

Hmm, maybe:

Suggested change

/// Returns `true` if this item, or any of its parent definitions, has type

/// or const generic parameters. This applies to functions, constants, statics,

/// and any item nested inside a generic context.

/// Returns `true` if this item has type or const generic parameters or is

/// defined inside an item that does. This applies to functions, constants, statics,

/// and any item nested inside a generic context.

mejrs · 2026-07-15T21:41:39Z

+//! access to the API within a callback. All queries must be performed inside this callback
+//! since the data structures are tied to the compiler's thread-local state.
+//!
+//! ```rust,ignore (requires compiler session)


Suggested change

//! ```rust,ignore (requires compiler session)

//! ```rust,no_run (requires compiler session)

View changes since the review

I don't think this will compile either

I'm quite wary of untested doc examples, especially here...from my experience they eventually bitrot away.

The example can't be tested as a doctest today because it requires linking against the stage2 of the rustc_driver library. As part of publishing rustc_public, we are working on CI improvements of the rustc_public repository. There we should be able to configure CI to keep examples tested.

For now I'll keep it simple with ignore, or would you rather I drop it entirely until we can properly test it?

maybe leave a fixme then?

mejrs · 2026-07-15T21:43:52Z

+//!     // ... analyze items ...
+//!     ControlFlow::Continue(())
+//! });
+//! ```


Can this example actually do something? Considering the other items documented in this pr, maybe a check that you aren't using multiple versions of the same crate? See https://github.com/TheBevyFlock/bevy_cli/blob/main/bevy_lint/src/lints/nursery/duplicate_bevy_dependencies.rs for example.

View changes since the review

mejrs · 2026-07-15T22:11:52Z

+    /// Returns `true` if this item, or any of its parent definitions, has type
+    /// or const generic parameters. This applies to functions, constants, statics,
+    /// and any item nested inside a generic context.


What is a parent definition precisely?🤔

makai410

The overall changes look good to me

View changes since this review

makai410 · 2026-07-16T07:56:22Z

+    /// Returns `true` if this item, or any of its parent definitions, has type
+    /// or const generic parameters. This applies to functions, constants, statics,
+    /// and any item nested inside a generic context.


I'd say a parent definition is the DefId of the enclosing item of this item, and this item inherits the enclosing item's generic parameters.

- Add a concrete code example (duplicate crate detection) - Clarify requires_monomorphization doc - Add FIXME for Symbol type alias Co-authored-by: Bruno Kolenbrander <[email protected]>

mejrs

Thanks!

r? me @bors r+ rollup

View changes since this review

rust-bors · 2026-07-19T10:16:22Z

📌 Commit adac776 has been approved by mejrs

It is now in the queue for this repository.

…uwer Rollup of 6 pull requests Successful merges: - #159524 (Gather PGO profiles in parallel) - #158850 (Avoid underflow for splatted rust-call receivers) - #159215 ([compiletest] Differentiate between LLVM LLDB and Apple LLDB) - #159347 (Document rustc_public lib.rs and update README) - #159469 (Reorganize `tests/ui/issues` [27/N]) - #159512 (Add regression tests for fixed dead-code issues)

Rollup merge of #159347 - celinval:docs/rpub-lib, r=mejrs Document rustc_public lib.rs and update README Add module-level documentation with usage example, crate discovery guide, and status section. Document all public types, methods, and free functions in lib.rs. Update README to reflect the crate rename from `stable_mir`/`rustc_smir` to `rustc_public`/`rustc_public_bridge`. Disclaimer: I used AI to help me generate the documentation.

rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. labels Jul 15, 2026

rustbot assigned scottmcm Jul 15, 2026

mejrs reviewed Jul 15, 2026

View reviewed changes

makai410 reviewed Jul 16, 2026

View reviewed changes

[rpub] Address review comments on rustc_public doc

adac776

- Add a concrete code example (duplicate crate detection) - Clarify requires_monomorphization doc - Add FIXME for Symbol type alias Co-authored-by: Bruno Kolenbrander <[email protected]>

celinval force-pushed the docs/rpub-lib branch from 51b35df to adac776 Compare July 17, 2026 22:27

mejrs approved these changes Jul 19, 2026

View reviewed changes

rustbot assigned mejrs Jul 19, 2026

rust-bors Bot added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jul 19, 2026

rustbot unassigned scottmcm Jul 19, 2026

JonathanBrouwer mentioned this pull request Jul 19, 2026

Rollup of 6 pull requests #159569

Merged

rust-bors Bot merged commit 44765b6 into rust-lang:main Jul 19, 2026
13 checks passed

rustbot added this to the 1.99.0 milestone Jul 19, 2026

	//! ```rust,ignore (requires compiler session)
	//! ```rust,no_run (requires compiler session)

Uh oh!

Uh oh!

Conversation

celinval commented Jul 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rustbot commented Jul 15, 2026

Uh oh!

rustbot commented Jul 15, 2026

Uh oh!

mejrs Jul 15, 2026 • edited by rustbot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mejrs Jul 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mejrs Jul 15, 2026 • edited by rustbot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mejrs Jul 15, 2026 • edited by rustbot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mejrs Jul 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

makai410 left a comment • edited by rustbot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mejrs left a comment • edited by rustbot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rust-bors Bot commented Jul 19, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

celinval commented Jul 15, 2026 •

edited

Loading

mejrs Jul 15, 2026 •

edited by rustbot

Loading

mejrs Jul 15, 2026 •

edited

Loading

mejrs Jul 15, 2026 •

edited by rustbot

Loading

mejrs Jul 15, 2026 •

edited by rustbot

Loading

mejrs Jul 15, 2026 •

edited

Loading

makai410 left a comment •

edited by rustbot

Loading

mejrs left a comment •

edited by rustbot

Loading