Skip to content

Improve --remap-path-prefix documentation #142372

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 1 commit into from
Aug 14, 2025
Merged

Improve --remap-path-prefix documentation #142372

merged 1 commit into from
Aug 14, 2025

Conversation

Urgau
Copy link
Member

@Urgau Urgau commented Jun 11, 2025

This PR improves the --remap-path-prefix documentation by:

  • moving it into it's own page
  • adding a small example
  • mentioning that the remapping is best effort1
  • mentioning link.exe/PDB issues2
  • mentioning the path separator issue (textual replacement)

r? @wesleywiser

Footnotes

  1. #t-compiler > link.exe leaking paths in Windows PDB @ 💬 ↩

  2. #t-compiler > link.exe leaking paths in Windows PDB @ 💬 ↩

@rustbot rustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jun 11, 2025
@Urgau Urgau added A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools A-path-remapping Area: path remapping, --remap-path-prefix, --remap-cwd-prefix, --remap-diagnostics-scope etc. labels Jun 11, 2025
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@Urgau Urgau force-pushed the improve-remap_path_prefix-doc branch from 993bf1e to e4938cb Compare June 11, 2025 17:56
weihanglo
weihanglo reviewed Jun 12, 2025
View reviewed changes
@Urgau Urgau force-pushed the improve-remap_path_prefix-doc branch from e4938cb to b224947 Compare June 12, 2025 16:42
@Urgau Urgau mentioned this pull request Jun 26, 2025
Open
@Urgau Urgau force-pushed the improve-remap_path_prefix-doc branch 2 times, most recently from 088dbf8 to 9f15c4f Compare July 12, 2025 17:05
wesleywiser
wesleywiser approved these changes Aug 13, 2025
View reviewed changes
Copy link
Member

@wesleywiser wesleywiser left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few comments but overall this looks great to me!

@Urgau @weihanglo @wesleywiser
Improve --remap-path-prefix documentation
7b5d9ef 
Co-Authored-By: Weihang Lo <[email protected]>
Co-Authored-By: Wesley Wiser <[email protected]>
@Urgau Urgau force-pushed the improve-remap_path_prefix-doc branch from 9f15c4f to 7b5d9ef Compare August 13, 2025 18:20
@wesleywiser
Copy link
Member

Thanks for getting these docs into shape!

@bors r+ rollup

@bors
Copy link
Collaborator

bors commented Aug 13, 2025

📌 Commit 7b5d9ef has been approved by wesleywiser

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 13, 2025
Zalathar added a commit to Zalathar/rust that referenced this pull request Aug 14, 2025
@Zalathar
Rollup merge of rust-lang#142372 - Urgau:improve-remap_path_prefix-do…
1d16c81 
…c, r=wesleywiser

Improve `--remap-path-prefix` documentation

This PR improves the `--remap-path-prefix` documentation by:
 - moving it into it's own page
 - adding a small example
 - mentioning that the remapping is best effort[^1]
 - mentioning `link.exe`/PDB issues[^2]
 - mentioning the path separator issue (textual replacement)

r? `@wesleywiser`

[^1]: [#t-compiler > link.exe leaking paths in Windows PDB @ 💬](https://rust-lang.zulipchat.com/#narrow/channel/131828-t-compiler/topic/link.2Eexe.20leaking.20paths.20in.20Windows.20PDB/near/523343774)
[^2]: [#t-compiler > link.exe leaking paths in Windows PDB @ 💬](https://rust-lang.zulipchat.com/#narrow/channel/131828-t-compiler/topic/link.2Eexe.20leaking.20paths.20in.20Windows.20PDB/near/523331762)
@Zalathar Zalathar mentioned this pull request Aug 14, 2025
Closed
bors added a commit that referenced this pull request Aug 14, 2025
@bors
Auto merge of #145373 - Zalathar:rollup-079tzmp, r=Zalathar
3478ce9 
Rollup of 13 pull requests

Successful merges:

 - #122661 (Change the desugaring of `assert!` for better error output)
 - #142372 (Improve `--remap-path-prefix` documentation)
 - #143075 (compiler: Allow `extern "interrupt" fn() -> !`)
 - #145005 (strip prefix of temporary file names when it exceeds filesystem name length limit)
 - #145065 (resolve: Introduce `RibKind::Block`)
 - #145120 (llvm: Accept new LLVM lifetime format)
 - #145189 (Weekly `cargo update`)
 - #145261 (Improve tracing in bootstrap)
 - #145266 (Reduce some queries around associated items)
 - #145299 (doc test: fix mpsc.rs try_send doc test)
 - #145331 (Make std use the edition 2024 prelude)
 - #145353 (bootstrap: Fix jemalloc 64K page support for aarch64 tools)
 - #145361 (Suppress wrapper suggestion when expected and actual ty are the same adt and the variant is unresolved)

Failed merges:

 - #145324 (Rename and document `ONLY_HOSTS` in bootstrap)
 - #145372 (resolve: Miscellaneous cleanups)

r? `@ghost`
`@rustbot` modify labels: rollup
bors added a commit that referenced this pull request Aug 14, 2025
@bors
Auto merge of #145373 - Zalathar:rollup-079tzmp, r=Zalathar
f87377a 
Rollup of 13 pull requests

Successful merges:

 - #122661 (Change the desugaring of `assert!` for better error output)
 - #142372 (Improve `--remap-path-prefix` documentation)
 - #143075 (compiler: Allow `extern "interrupt" fn() -> !`)
 - #145005 (strip prefix of temporary file names when it exceeds filesystem name length limit)
 - #145065 (resolve: Introduce `RibKind::Block`)
 - #145120 (llvm: Accept new LLVM lifetime format)
 - #145189 (Weekly `cargo update`)
 - #145261 (Improve tracing in bootstrap)
 - #145266 (Reduce some queries around associated items)
 - #145299 (doc test: fix mpsc.rs try_send doc test)
 - #145331 (Make std use the edition 2024 prelude)
 - #145353 (bootstrap: Fix jemalloc 64K page support for aarch64 tools)
 - #145361 (Suppress wrapper suggestion when expected and actual ty are the same adt and the variant is unresolved)

Failed merges:

 - #145324 (Rename and document `ONLY_HOSTS` in bootstrap)
 - #145372 (resolve: Miscellaneous cleanups)

r? `@ghost`
`@rustbot` modify labels: rollup
@GuillaumeGomez GuillaumeGomez mentioned this pull request Aug 14, 2025
Merged
bors added a commit that referenced this pull request Aug 14, 2025
@bors
Auto merge of #145388 - GuillaumeGomez:rollup-hnlt5ov, r=GuillaumeGomez
30017c3 
Rollup of 13 pull requests

Successful merges:

 - #140434 (rustdoc: Allow multiple references to a single footnote)
 - #142372 (Improve `--remap-path-prefix` documentation)
 - #142741 (Fix unsoundness in some tests)
 - #144515 (Implement `ptr_cast_array`)
 - #144727 (Add tracing to resolve-related functions)
 - #144959 (fix(unicode-table-generator): fix duplicated unique indices)
 - #145179 (Avoid abbreviating "numerator" as "numer", to allow catching typo "numer" elsewhere)
 - #145250 (Add regression test for a former ICE involving helper attributes containing interpolated tokens)
 - #145266 (Reduce some queries around associated items)
 - #145299 (doc test: fix mpsc.rs try_send doc test)
 - #145323 (Port the `#[linkage]` attribute to the new attribute system)
 - #145361 (Suppress wrapper suggestion when expected and actual ty are the same adt and the variant is unresolved)
 - #145372 (resolve: Miscellaneous cleanups)

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 90a5e62 into rust-lang:master Aug 14, 2025
10 checks passed
@rustbot rustbot added this to the 1.91.0 milestone Aug 14, 2025
rust-timer added a commit that referenced this pull request Aug 14, 2025
@rust-timer
Unrolled build for #142372
ab0618f 
Rollup merge of #142372 - Urgau:improve-remap_path_prefix-doc, r=wesleywiser

Improve `--remap-path-prefix` documentation

This PR improves the `--remap-path-prefix` documentation by:
 - moving it into it's own page
 - adding a small example
 - mentioning that the remapping is best effort[^1]
 - mentioning `link.exe`/PDB issues[^2]
 - mentioning the path separator issue (textual replacement)

r? ``@wesleywiser``

[^1]: [#t-compiler > link.exe leaking paths in Windows PDB @ 💬](https://rust-lang.zulipchat.com/#narrow/channel/131828-t-compiler/topic/link.2Eexe.20leaking.20paths.20in.20Windows.20PDB/near/523343774)
[^2]: [#t-compiler > link.exe leaking paths in Windows PDB @ 💬](https://rust-lang.zulipchat.com/#narrow/channel/131828-t-compiler/topic/link.2Eexe.20leaking.20paths.20in.20Windows.20PDB/near/523331762)
github-actions bot pushed a commit to rust-lang/miri that referenced this pull request Aug 15, 2025
@bors
Auto merge of #145388 - GuillaumeGomez:rollup-hnlt5ov, r=GuillaumeGomez
0372ef9 
Rollup of 13 pull requests

Successful merges:

 - rust-lang/rust#140434 (rustdoc: Allow multiple references to a single footnote)
 - rust-lang/rust#142372 (Improve `--remap-path-prefix` documentation)
 - rust-lang/rust#142741 (Fix unsoundness in some tests)
 - rust-lang/rust#144515 (Implement `ptr_cast_array`)
 - rust-lang/rust#144727 (Add tracing to resolve-related functions)
 - rust-lang/rust#144959 (fix(unicode-table-generator): fix duplicated unique indices)
 - rust-lang/rust#145179 (Avoid abbreviating "numerator" as "numer", to allow catching typo "numer" elsewhere)
 - rust-lang/rust#145250 (Add regression test for a former ICE involving helper attributes containing interpolated tokens)
 - rust-lang/rust#145266 (Reduce some queries around associated items)
 - rust-lang/rust#145299 (doc test: fix mpsc.rs try_send doc test)
 - rust-lang/rust#145323 (Port the `#[linkage]` attribute to the new attribute system)
 - rust-lang/rust#145361 (Suppress wrapper suggestion when expected and actual ty are the same adt and the variant is unresolved)
 - rust-lang/rust#145372 (resolve: Miscellaneous cleanups)

r? `@ghost`
`@rustbot` modify labels: rollup
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@weihanglo weihanglo weihanglo left review comments

@wesleywiser wesleywiser wesleywiser approved these changes

Assignees

@wesleywiser wesleywiser

Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools A-path-remapping Area: path remapping, --remap-path-prefix, --remap-cwd-prefix, --remap-diagnostics-scope etc. S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Milestone
1.91.0
Development

Successfully merging this pull request may close these issues.
6 participants
@Urgau @rust-log-analyzer @wesleywiser @bors @weihanglo @rustbot