Skip to content

Support multiple crate versions in --extern-html-root-url #143465

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 5 commits into from
Jul 30, 2025
Merged

Support multiple crate versions in --extern-html-root-url #143465

merged 5 commits into from
Jul 30, 2025

Conversation

kornelski
Copy link
Contributor

@kornelski kornelski commented Jul 5, 2025 •
edited by rustbot
Loading

Rustdoc's --extern-html-root-url used to use tcx.crate_name() to identify crates, but that used crates' internal names from their metadata, instead of names given to them in --extern. That was confusing, because both --extern… arguments seem related and use similar syntax. Crucially, this didn't work correctly with Cargo's package aliases or multiple versions of crates.

sess.opts.externs lacks CrateNum, and Resolver.extern_prelude gets destroyed before rustdoc has a chance to see it, so I've had to save this mapping in CStore.

Just in case, I've kept the previous mapping by crate name as a fallback for crates that weren't matched by their extern name.

Fixes #76296

@rustbot
Copy link
Collaborator

rustbot commented Jul 5, 2025

r? @SparrowLii

rustbot has assigned @SparrowLii.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output. labels Jul 5, 2025
@kornelski kornelski mentioned this pull request Jul 5, 2025
Closed
@kornelski kornelski changed the title Avoid redundant lookup in CrateLoader::existing_match Support multiple crate versions in --extern-html-root-url Jul 5, 2025
@kornelski
Copy link
Contributor Author

And f9f6a70 is just a bit of redundant code I've noticed in the process, too small to give it a separate PR.

@rust-log-analyzer

This comment has been minimized.

Sign in to view
@jyn514
Copy link
Member

jyn514 commented Jul 5, 2025

cc @aDotInTheVoid @obi1kenobi - i haven’t checked if this will help distinguish versions for the json backend too but i think it might

@kornelski
Copy link
Contributor Author

Yes, the URL is in the JSON, and can be creatively used to identify the crates.

@jyn514
Copy link
Member

jyn514 commented Jul 5, 2025

to be clear i do not think html-root-url should be used for this, i’m saying the new metadata you’ve added to CrateRoot might allow the json backend to emit structured metadata.

@Nemo157
Copy link
Member

Nemo157 commented Jul 5, 2025

#76296 doesn't demonstrate the entirety of how rustdoc has issues with resolving crate versions. There's also the case of non-renamed transitively reëxported multiple versions of a single package name.

obi1kenobi
obi1kenobi reviewed Jul 5, 2025
View reviewed changes
@lolbinarycat
Copy link
Contributor

I think the name resolution method used here should be documented in the rustdoc book

@petrochenkov petrochenkov self-assigned this Jul 5, 2025
lolbinarycat
lolbinarycat reviewed Jul 6, 2025
View reviewed changes
@aDotInTheVoid
Copy link
Member

CC rust-lang/cargo#8296

@aDotInTheVoid aDotInTheVoid mentioned this pull request Jul 7, 2025
Open
13 tasks
@petrochenkov
Copy link
Contributor

This is better than I originally assumed, the crate lookup algorithm is not changed, only some already calculated data is exposed.
Also, delegating --extern-html-root-url to --extern seems like the best solution that we can do here.

@petrochenkov petrochenkov added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jul 14, 2025
@rustbot

This comment has been minimized.

Sign in to view
TroyKomodo
TroyKomodo reviewed Jul 17, 2025
View reviewed changes
@bors

This comment was marked as resolved.

Sign in to view
@kornelski kornelski force-pushed the extern-name branch 2 times, most recently from b0125e5 to 75c2eef Compare July 22, 2025 20:35
@rust-log-analyzer

This comment has been minimized.

Sign in to view
kornelski added 5 commits July 28, 2025 13:34
@kornelski
Avoid redundant lookup in CrateLoader::existing_match
e008fe0
@kornelski
Clarify update_extern_crate
671e083
@kornelski
Save names of used extern crates
8a0f976 
Tracks association between `self.sess.opts.externs` (aliases in `--extern alias=rlib`) and resolved `CrateNum`

Intended to allow Rustdoc match the aliases in `--extern-html-root-url`

Force-injected extern crates aren't included, since they're meant for the linker only
@kornelski
Test renamed crates in rustdoc
0813cc9
@kornelski
Support multiple crate versions in --extern-html-root-url
276c423
@kornelski
Copy link
Contributor Author

@petrochenkov is this okay to merge then?

@petrochenkov
Copy link
Contributor

This was never marked as S-waiting-on-review so I never looked at it again.
I'll look.
@rustbot ready

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Jul 29, 2025
@petrochenkov
Copy link
Contributor

@bors r+

@bors
Copy link
Collaborator

bors commented Jul 30, 2025

📌 Commit 276c423 has been approved by petrochenkov

It is now in the queue for this repository.

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jul 30, 2025
@samueltardieu samueltardieu mentioned this pull request Jul 30, 2025
Merged
bors added a commit that referenced this pull request Jul 30, 2025
@bors
Auto merge of #144692 - samueltardieu:rollup-0j1y08x, r=samueltardieu
3048886 
Rollup of 4 pull requests

Successful merges:

 - #143465 (Support multiple crate versions in --extern-html-root-url)
 - #144308 ([rustdoc] Display total time and compilation time of merged doctests)
 - #144655 (clean up codegen fn attrs)
 - #144675 (Reject running `compiletest` self-tests against stage 0 rustc unless explicitly allowed)

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit b38ece9 into rust-lang:master Jul 30, 2025
10 checks passed
@rustbot rustbot added this to the 1.90.0 milestone Jul 30, 2025
rust-timer added a commit that referenced this pull request Jul 30, 2025
@rust-timer
Unrolled build for #143465
ec9a02c 
Rollup merge of #143465 - kornelski:extern-name, r=petrochenkov

Support multiple crate versions in --extern-html-root-url

Rustdoc's `--extern-html-root-url` used to use `tcx.crate_name()` to identify crates, but that used crates' internal names from their metadata, instead of names given to them in `--extern`. That was confusing, because both `--extern…` arguments seem related and use similar syntax. Crucially, this didn't work correctly with Cargo's package aliases or multiple versions of crates.

`sess.opts.externs` lacks `CrateNum`, and `Resolver.extern_prelude` gets destroyed before `rustdoc` has a chance to see it, so I've had to save this mapping in `CStore`.

Just in case, I've kept the previous mapping by crate name as a fallback for crates that weren't matched by their extern name.

Fixes #76296
@kornelski kornelski deleted the extern-name branch August 25, 2025 12:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@petrochenkov petrochenkov petrochenkov left review comments

@lolbinarycat lolbinarycat lolbinarycat left review comments

+2 more reviewers

@obi1kenobi obi1kenobi obi1kenobi left review comments

@TroyKomodo TroyKomodo TroyKomodo left review comments

Reviewers whose approvals may not affect merge requirements
Assignees

@petrochenkov petrochenkov

Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output.
Projects
None yet
Milestone
1.90.0
Development

Successfully merging this pull request may close these issues.

--extern-html-root-url uses library names to identify dependencies, failing to handle multiple versions