Use local links in the alloc docs. #74352
Merged
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.
Links to other crates (like core) from the alloc crate were incorrectly using the
https://doc.rust-lang.org/nightly/
absolute (remote) links, instead of relative (local) links. For example, the link toResult
at https://doc.rust-lang.org/1.44.1/alloc/vec/struct.Vec.html#method.try_reserve goes to /nightly/.This is because alloc was being documented before core, and rustdoc relies on the existence of the local directory to know if it should use a local or remote link.
There was code that tried to compensate for this (
create_dir_all
), but in #54543 it was broken because instead of runningcargo doc
once for all the crates, it was changed to runcargo rustdoc
for each crate individually. This means thatcreate_dir_all
was no longer doing what it was supposed to be doing (creating all the directories before starting).The solution here is to just build in the correct order (from the dependency leaves towards the root). An alternate solution would be to switch back to running
cargo doc
once (and use RUSTDOCFLAGS for passing in flags). Another alternate solution would be to iterate over the list twice, creating the directories during the first pass.I also did a little cleanup to remove the "crate-docs" directory. This was added in the past because different crates were built in different directories. Over time, things have been unified (and rustc docs no longer include std), so it is no longer necessary.