fix: stabilize -Zrustdoc-depinfo#17020
Draft
weihanglo wants to merge 1 commit into
Draft
Conversation
With this stabilization, `cargo doc` unconditionally emits rustdoc depinfo via `rustdoc --emit=dep-info`. Before this, `cargo doc` used to track file changes via filesystem traversal. The depinfo files are emitted to Cargo's fingerprint which is a private location so we don't have to commit any stability around it if we want to move it somewhere else in future versions.
rustbot
added
A-build-execution
Collaborator
|
r? @epage rustbot has assigned @epage. Use Why was this reviewer chosen?The reviewer was selected based on:
|
Member
Author
|
Oops. This is not going to work without flagging every cargo doc test case nightly-only 🥲 |
rustbot
removed
the
S-waiting-on-review
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
3 participants
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.
What does this PR try to resolve?
With this stabilization,
cargo docunconditionally emits rustdoc depinfovia
rustdoc --emit=dep-info.Before this,
cargo docused to track file changes via filesystem traversal just like build scripts, and it cannot detect these cases:lib.path = "../lib.rs"include_str!to include files outisde pakcage root, e.g.,#[doc = include_str!("../outside/pkgroot")]#[path = "../outside/pkgroot"]env!in doc attribute, e.g.,#[doc = env!("…")]The depinfo files are emitted to Cargo's fingerprint which is a private location so we don't have to commit any stability around it if we want to move it somewhere else in future versions.
Fixes #15370
How to test and review this PR?
While this is a bugfix, I assume we still need an FCP for it.