Allow rustdoc JSON rustup component to be installed on stable.#156926
Open
obi1kenobi wants to merge 1 commit into
Open
Allow rustdoc JSON rustup component to be installed on stable.#156926obi1kenobi wants to merge 1 commit into
obi1kenobi wants to merge 1 commit into
Conversation
Member
Author
|
@rustbot label +T-rustdoc +A-rustdoc-json |
This comment was marked as resolved.
This comment was marked as resolved.
Member
Author
|
@rustbot label -T-rustdoc thanks Urgau! I misspelled the rustdoc JSON team label 🙈 |
This file contains hidden or 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
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.
Currently, the
rust-docs-jsoncomponent is only available on nightly Rust.It would be very useful to
cargo-semver-checksto have rustdoc JSON available in stable as well, to allow performing cross-crate linting that involves types fromstd/core/allocetc. 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-jsoncomponent. 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