Skip to content

Allow rustdoc JSON rustup component to be installed on stable.#156926

Open
obi1kenobi wants to merge 1 commit into
rust-lang:mainfrom
obi1kenobi:pg/ship-rustdoc-json-with-stable
Open

Allow rustdoc JSON rustup component to be installed on stable.#156926
obi1kenobi wants to merge 1 commit into
rust-lang:mainfrom
obi1kenobi:pg/ship-rustdoc-json-with-stable

Conversation

@obi1kenobi
Copy link
Copy Markdown
Member

@obi1kenobi obi1kenobi commented May 25, 2026

Currently, the rust-docs-json component is only available on nightly Rust.

It would be very useful to cargo-semver-checks to have rustdoc JSON available in stable as well, to allow performing cross-crate linting that involves types from std/core/alloc etc. This will also simplify the process of linting the standard library itself for possible breaking changes, which is something T-libs is interested in as well.

Even though rustdoc JSON is an unstable component, each JSON file carries a version number meaning that the installed files remain parseable and usable with the matching version of rustdoc-types. So even though future stable Rust releases may change the format, it still makes sense to provide this machine-readable artifact that says "this is what the standard lib contained in this stable release."

For avoidance of confusion: different stable releases may ship mutually-incompatible rustdoc format versions in the rust-docs-json component. The component's contents and shape are valid with respect only to the toolchain in which it is found, analogously to how the rustdoc HTML docs component works.

r? @Mark-Simulacrum @GuillaumeGomez

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) labels May 25, 2026
@obi1kenobi
Copy link
Copy Markdown
Member Author

obi1kenobi commented May 25, 2026

@rustbot label +T-rustdoc +A-rustdoc-json

@rustbot

This comment was marked as resolved.

@rustbot rustbot added A-rustdoc-json Area: Rustdoc JSON backend T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels May 25, 2026
@Urgau Urgau added needs-fcp This change is insta-stable, or significant enough to need a team FCP to proceed. A-rustdoc-json Area: Rustdoc JSON backend T-rustdoc-json-backend Relevant to the rustdoc JSON backend team, which will review and decide on the PR/issue. and removed A-rustdoc-json Area: Rustdoc JSON backend labels May 25, 2026
@obi1kenobi
Copy link
Copy Markdown
Member Author

@rustbot label -T-rustdoc

thanks Urgau! I misspelled the rustdoc JSON team label 🙈

@rustbot rustbot removed the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label May 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-rustdoc-json Area: Rustdoc JSON backend needs-fcp This change is insta-stable, or significant enough to need a team FCP to proceed. S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) T-rustdoc-json-backend Relevant to the rustdoc JSON backend team, which will review and decide on the PR/issue.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants