Skip to content

Tracking Issue for -Zrustdoc-depinfo #15370

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
1 task
weihanglo opened this issue Mar 31, 2025 · 0 comments
Open
1 task

Tracking Issue for -Zrustdoc-depinfo #15370

weihanglo opened this issue Mar 31, 2025 · 0 comments
Labels
A-rebuild-detection Area: rebuild detection and fingerprinting C-tracking-issue Category: A tracking issue for something unstable. Command-doc S-waiting-on-feedback Status: An implemented feature is waiting on community feedback for bugs or design concerns.

Comments

@weihanglo
Copy link
Member

Summary

Original issue: #12266
Implementation: #15359
Documentation: https://doc.rust-lang.org/nightly/cargo/reference/unstable.html#rustdoc-depinfo

The -Z rustdoc-depinfo flag leverages rustdoc’s dep-info files to determine whether documentations are required to re-generate. This can be combined with -Z checksum-freshness to detect checksum changes rather than file mtime.

Unresolved Issues

Open design questions:

  • Where should rustdoc dep-info be emitted to?
    • The current implementation is under the fingerprint directory, e.g., target/debug/.fingerprint/serde-12d29d32b3b8b38f/doc-lib-serde.d

Future Extensions

  • Rustdoc should track extra theme/ CSS files as part of the rebuild detection

About tracking issues

Tracking issues are used to record the overall progress of implementation.
They are also used as hubs connecting to other relevant issues, e.g., bugs or open design questions.
A tracking issue is however not meant for large scale discussion, questions, or bug reports about a feature.
Instead, open a dedicated issue for the specific matter and add the relevant feature gate label.

@weihanglo weihanglo added A-rebuild-detection Area: rebuild detection and fingerprinting C-tracking-issue Category: A tracking issue for something unstable. Command-doc S-waiting-on-feedback Status: An implemented feature is waiting on community feedback for bugs or design concerns. labels Mar 31, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-rebuild-detection Area: rebuild detection and fingerprinting C-tracking-issue Category: A tracking issue for something unstable. Command-doc S-waiting-on-feedback Status: An implemented feature is waiting on community feedback for bugs or design concerns.
Projects
Status: No status
Development

No branches or pull requests

1 participant