user0/rust
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Rollup merge of #150393 - Urgau:remap-path-relative-doc, r=jieyouxu

Browse source 
Document relative and absolute paths handling in `--remap-path-prefix`

After what we have been through with https://github.com/rust-lang/rust/pull/150110 and https://github.com/rust-lang/rust/pull/150283 in the compiler, I think it would be good to document the user-facing parts of the relative and absolute paths handling in `--remap-path-prefix`.

r? `@jieyouxu`
This commit is contained in:
Jonathan Brouwer 2025-12-27 13:42:01 +01:00 • committed by GitHub
commit b1fd0b3f2f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 14 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

14
src/doc/rustc/src/remap-source-paths.md
View file

@ -17,6 +17,20 @@ The replacement is purely textual, with no consideration of the current system's
When multiple remappings are given and several of them match, the **last** matching one is applied.
### Relative paths
Some build systems, such as Cargo, may compile crates using relative paths (for example,
`src/main.rs` instead of `/home/user/project/src/main.rs)`.
`rustc` preserves these relative paths where possible. However, certain inputs
(like `#[path = "..."]`) and outputs (such as debug information) may still contain absolute paths.
To ensure consistency, it’s recommended to remap both relative and absolute paths.
```bash
rustc --remap-path-prefix "src/=/redacted/src" --remap-path-prefix "/home/user/project=/redacted"
```
### Example
```bash