Skip to content
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

Fix rustdoc missing handling of remap-path-prefix option #128736

Merged
merged 2 commits into from
Aug 7, 2024
Merged

Fix rustdoc missing handling of remap-path-prefix option #128736

merged 2 commits into from
Aug 7, 2024

Conversation

GuillaumeGomez
Copy link
Member

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Aug 6, 2024
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@GuillaumeGomez
Copy link
Member Author

Fixed fmt...

@weihanglo
Copy link
Member

One question: Should rustdoc respect -Zremap-path-scope?

From my understanding, besides doctest, the only thing needing to be remapped in rustdoc is diagnostics. Rustdoc might not need to be aware of any scope. Cargo can determine and pass --remap-path-prefix accordingly. Hence my personal anwser to this is no.

@GuillaumeGomez
Copy link
Member Author

My answer will be: if you can find a case where it's useful, I can add it. :)

@weihanglo
Copy link
Member

From my understanding, besides doctest, the only thing needing to be remapped in rustdoc is diagnostics.

Is there anything that contains absolute/original source path in rustdoc generated artifacts?

@GuillaumeGomez
Copy link
Member Author

Not that I can think of.

@notriddle
Copy link
Contributor

This definitely seems like an improvement.

@bors r+

Is there anything that contains absolute/original source path in rustdoc generated artifacts?

Source code pages can. Here's an example of how to see that.

@bors
Copy link
Contributor

bors commented Aug 6, 2024

📌 Commit f43e92b has been approved by notriddle

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 Aug 6, 2024
@matthiaskrgr matthiaskrgr mentioned this pull request Aug 6, 2024
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Aug 6, 2024
@bors
Auto merge of rust-lang#128748 - matthiaskrgr:rollup-dzvi5f7, r=matth…
0ddead3 
…iaskrgr

Rollup of 7 pull requests

Successful merges:

 - rust-lang#128369 (rustc_lint: make `let-underscore-lock` translatable)
 - rust-lang#128377 (Fix ICE Caused by Incorrectly Delaying E0107)
 - rust-lang#128517 (Fallback to string formatting if source is not available for lint)
 - rust-lang#128685 (Remove the root Cargo.lock from the rust-src component)
 - rust-lang#128693 (rustdoc-search: account for numeric disambiguators on impls)
 - rust-lang#128720 (Pass the right `ParamEnv` to `might_permit_raw_init_strict`)
 - rust-lang#128736 (Fix rustdoc missing handling of remap-path-prefix option)

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 47a2f14 into rust-lang:master Aug 7, 2024
6 checks passed
rust-timer added a commit to rust-lang-ci/rust that referenced this pull request Aug 7, 2024
@rust-timer
Unrolled build for rust-lang#128736
3b3b971 
Rollup merge of rust-lang#128736 - GuillaumeGomez:fix-remap-path-prefix, r=notriddle

Fix rustdoc missing handling of remap-path-prefix option

Fixes rust-lang#69264.

cc `@weihanglo`
r? `@notriddle`
@rustbot rustbot added this to the 1.82.0 milestone Aug 7, 2024
@GuillaumeGomez GuillaumeGomez deleted the fix-remap-path-prefix branch August 7, 2024 09:24
@weihanglo weihanglo mentioned this pull request Aug 7, 2024
Open
6 tasks
@jieyouxu jieyouxu mentioned this pull request Aug 14, 2024
Open
81 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@notriddle notriddle

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

Successfully merging this pull request may close these issues.

rustdoc: use remap-path-prefix
6 participants
@GuillaumeGomez @rust-log-analyzer @weihanglo @notriddle @bors @rustbot