docs: repair the three rustdoc links the doc gate reports - #7789
Open
oferchen wants to merge 2 commits into
Open
docs: repair the three rustdoc links the doc gate reports#7789oferchen wants to merge 2 commits into
oferchen wants to merge 2 commits into
Conversation
The rustdoc-links job runs only on ubuntu with --all-features, so it is structurally blind to a link whose target is behind a target_os cfg. Run on macOS, the job's own command exits 101: crates/fast_io/src/pinned_root.rs:57 links crate::pinned_root::open_o_path, which is cfg(any(target_os = "linux", target_os = "android")). The link resolves on the runner and is unresolvable everywhere else, so `cargo doc` fails for anyone building docs off Linux. The doc text already says the item "stays Linux-only", so backtick-only is the accurate spelling; the target sits in the same module a reader is already in. That hard error aborted the run before two later crates were documented, which is how a second and third finding stayed hidden until it was fixed: crates/fast_io/src/dir_sandbox/at_syscalls/nested.rs:178 links public documentation at anchor_parent, which is pub(super). crates/transfer/src/receiver/basis.rs:163 links InplaceBackupSpec's public documentation at crate::disk_commit::make_backup_copy, which is private. Both are private_intra_doc_links warnings on every platform, so both are already in the job's output on the runner. Same repair as dc09505: a public page does not link an item its reader cannot open. After this, both of the job's steps exit 0 with no errors and no warnings, on --all-features and on default features.
oferchen
enabled auto-merge (squash)
September 9, 2026 12:08
github-actions
Bot
added
the
documentation
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
1 participant
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.
Three intra-doc links the rustdoc job reports as broken:
crates/fast_io/src/dir_sandbox/at_syscalls/nested.rscrates/fast_io/src/pinned_root.rscrates/transfer/src/receiver/basis.rsOne line each, no behaviour touched.
The rustdoc-links job is currently
continue-on-error: true(ci.yml:242), sothese were reported and discarded rather than blocking. Making that job blocking
and required is a separate change — this one just empties the list it reports so
the flip has nothing pending behind it.
Rebased onto current master; the commit replays clean and its footprint is
exactly the three lines.