Improve --remap-path-prefix documentation
#142372
Merged
Conversation
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
This comment has been minimized.
This comment has been minimized.
993bf1e to
e4938cb
Compare
weihanglo
reviewed
Jun 12, 2025
e4938cb to
b224947
Compare
088dbf8 to
9f15c4f
Compare
wesleywiser
approved these changes
Aug 13, 2025
Co-Authored-By: Weihang Lo <me@weihanglo.tw> Co-Authored-By: Wesley Wiser <wwiser@gmail.com>
9f15c4f to
7b5d9ef
Compare
wesleywiser
approved these changes
Aug 13, 2025
|
Thanks for getting these docs into shape! @bors r+ rollup |
Zalathar
added a commit
to Zalathar/rust
that referenced
this pull request
Aug 14, 2025
…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)
bors
added a commit
that referenced
this pull request
Aug 14, 2025
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
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
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
rust-timer
added a commit
that referenced
this pull request
Aug 14, 2025
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
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
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.
This PR improves the
--remap-path-prefixdocumentation by:link.exe/PDB issues2r? @wesleywiser
Footnotes
#t-compiler > link.exe leaking paths in Windows PDB @ 💬 ↩
#t-compiler > link.exe leaking paths in Windows PDB @ 💬 ↩