fix: stabilize -Zrustdoc-depinfo#17020
Open
weihanglo wants to merge 1 commit into
Open
Conversation
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 🥲 |
weihanglo
marked this pull request as draft
May 20, 2026 21:00
rustbot
removed
the
S-waiting-on-review
weihanglo
force-pushed
the
rustdoc-depinfo
branch
from
June 6, 2026 13:19
c5f28e7 to
0cc616a
Compare
weihanglo
force-pushed
the
rustdoc-depinfo
branch
from
June 16, 2026 01:44
0cc616a to
94cc4e0
Compare
This comment has been minimized.
This comment has been minimized.
rustbot
added
the
S-waiting-on-author
weihanglo
force-pushed
the
rustdoc-depinfo
branch
2 times, most recently
from
July 6, 2026 15:46
1180628 to
e143eee
Compare
This comment has been minimized.
This comment has been minimized.
weihanglo
force-pushed
the
rustdoc-depinfo
branch
2 times, most recently
from
July 9, 2026 14:47
76c6730 to
b76bf7e
Compare
weihanglo
marked this pull request as ready for review
July 9, 2026 15:40
rustbot
added
the
S-waiting-on-review
This comment was marked as duplicate.
This comment was marked as duplicate.
Member
Author
|
@rfcbot fcp merge T-cargo |
Collaborator
|
@weihanglo has proposed to merge this. The next step is review by the rest of the tagged team members: No concerns currently listed. Once a majority of reviewers approve (and at most 2 approvals are outstanding), this will enter its final comment period. If you spot a major issue that hasn't been raised at any point in this process, please speak up! See this document for info about what commands tagged team members can give me. |
rust-rfcbot
added
proposed-final-comment-period
weihanglo
force-pushed
the
rustdoc-depinfo
branch
from
July 12, 2026 11:21
b76bf7e to
063ce16
Compare
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
weihanglo
force-pushed
the
rustdoc-depinfo
branch
from
July 12, 2026 16:08
063ce16 to
7e7f37a
Compare
This comment has been minimized.
This comment has been minimized.
weihanglo
removed
the
S-waiting-on-author
weihanglo
force-pushed
the
rustdoc-depinfo
branch
from
July 16, 2026 13:43
7e7f37a to
5c201d1
Compare
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
weihanglo
force-pushed
the
rustdoc-depinfo
branch
from
July 18, 2026 01:06
5c201d1 to
09a03c1
Compare
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
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. Note that `rustdoc --output-format json` still use the old package fingerprint because `--output-format json` is not yet compatible and controllable through `--emit`.
weihanglo
force-pushed
the
rustdoc-depinfo
branch
from
July 18, 2026 21:26
09a03c1 to
bed8e31
Compare
Collaborator
|
This PR was rebased onto a different master commit. Here's a range-diff highlighting what actually changed. Rebasing is a normal part of keeping PRs up to date, so no action is needed—this note is just to help reviewers. |
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
5 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.
---> FCP <---
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.