Pass the unremapped path to the `rustc` invocation for doctests by Urgau · Pull Request #163956 · rust-lang/rust

Urgau · 2026-10-07T19:22:26Z

Turns out that --remap-path-scope is only half working with doctests, this is because rustdoc use a secret environment variable to pass the real filename of the doctest.

However we were only passing a remapped path. That means that doctests source path were getting remapped, but only for one scope: documentation. It didn't respect macro for file! for example.

To fix this, we have to:

pass the local path to the rustc invocation
have rustc treat that path as a real filename and apply remapping per scope to it
- I had to add a new Input variant, otherwise I can't differentiate normal input - from doctests - source
we have to pass --remap-path-{prefix,scope} to rustc so the path actually gets remap properly

Thanks to @weihanglo for pointing me to the bug.

Relevant for #163895
r? @GuillaumeGomez

GuillaumeGomez

Apart from my nit, looks good to me, thanks! r=me once the name change is reverted

View changes since this review

Urgau · 2026-10-08T20:15:08Z

@bors r=GuillaumeGomez

rust-bors · 2026-10-08T20:15:11Z

📌 Commit 9cf4406 has been tentatively approved by GuillaumeGomez

It will be put into the queue for this repository once PR CI succeeds.

…illaumeGomez Pass the unremapped path to the `rustc` invocation for doctests Turns out that `--remap-path-scope` is only half working with doctests, this is because `rustdoc` use a secret environment variable to pass the real filename of the doctest. However we were only passing a remapped path. That means that doctests source path were getting remapped, but only for one scope: `documentation`. It didn't respect `macro` for `file!` for example. To fix this, we have to: 1. pass the local path to the `rustc` invocation 2. have `rustc` treat that path as a real filename and apply remapping per scope to it - I had to add a new `Input` variant, otherwise I can't differentiate normal input `-` from doctests `-` source 4. we have to pass `--remap-path-{prefix,scope}` to `rustc` so the path actually gets remap properly

…uwer Rollup of 7 pull requests Successful merges: - #162652 (Syntactically reject leading parenthesized precise capturing lists in bare trait object types (`(use<…>)+`)) - #163337 (MIR move elimination [3/6]: PreciseLiveness) - #163954 (fix(bootstrap/darwin): fix rpath for distributed LLD) - #163956 (Pass the unremapped path to the `rustc` invocation for doctests) - #163634 (move overflow lint computation into decorator) - #163727 (rigid aliases to non-rigid for fully normalized check) - #163745 (replace `fully_monomorphized` with `cx.typing_env()`)

…illaumeGomez Pass the unremapped path to the `rustc` invocation for doctests Turns out that `--remap-path-scope` is only half working with doctests, this is because `rustdoc` use a secret environment variable to pass the real filename of the doctest. However we were only passing a remapped path. That means that doctests source path were getting remapped, but only for one scope: `documentation`. It didn't respect `macro` for `file!` for example. To fix this, we have to: 1. pass the local path to the `rustc` invocation 2. have `rustc` treat that path as a real filename and apply remapping per scope to it - I had to add a new `Input` variant, otherwise I can't differentiate normal input `-` from doctests `-` source 4. we have to pass `--remap-path-{prefix,scope}` to `rustc` so the path actually gets remap properly

JonathanBrouwer · 2026-10-09T08:05:27Z

💔 I suspect this PR failed tests as part of a rollup
@bors r-

After fixing the problem, consider running a try job for the failed job before re-approving.

Link to failure: #164015 (comment)

rust-bors · 2026-10-09T08:05:34Z

This pull request was unapproved.

This PR was contained in a rollup (#164015), which was unapproved.

View changes since this unapproval

…uwer Rollup of 11 pull requests Successful merges: - #162652 (Syntactically reject leading parenthesized precise capturing lists in bare trait object types (`(use<…>)+`)) - #163337 (MIR move elimination [3/6]: PreciseLiveness) - #163954 (fix(bootstrap/darwin): fix rpath for distributed LLD) - #163956 (Pass the unremapped path to the `rustc` invocation for doctests) - #163634 (move overflow lint computation into decorator) - #163666 (Updates the expect message library/core/src/time.rs) - #163727 (rigid aliases to non-rigid for fully normalized check) - #163745 (replace `fully_monomorphized` with `cx.typing_env()`) - #164000 (When mentioning that closure doesn't implement trait, point at closure) - #164007 ([rustdoc] Prefer local paths over remote ones when foreign item is locally reexported) - #164017 (cg_llvm: Avoid some explicit casts to `*const c_char`)

Urgau · 2026-10-09T16:59:01Z

CI sometimes runs in /tmp, duh! Removed the faulty assertion.

@bors r=GuillaumeGomez

rust-bors · 2026-10-09T16:59:05Z

📌 Commit 85b2304 has been tentatively approved by GuillaumeGomez

It will be put into the queue for this repository once PR CI succeeds.

…illaumeGomez Pass the unremapped path to the `rustc` invocation for doctests Turns out that `--remap-path-scope` is only half working with doctests, this is because `rustdoc` use a secret environment variable to pass the real filename of the doctest. However we were only passing a remapped path. That means that doctests source path were getting remapped, but only for one scope: `documentation`. It didn't respect `macro` for `file!` for example. To fix this, we have to: 1. pass the local path to the `rustc` invocation 2. have `rustc` treat that path as a real filename and apply remapping per scope to it - I had to add a new `Input` variant, otherwise I can't differentiate normal input `-` from doctests `-` source 4. we have to pass `--remap-path-{prefix,scope}` to `rustc` so the path actually gets remap properly

…uwer Rollup of 24 pull requests Successful merges: - #161998 ( Support type-relative assoc item paths in generic param defaults & const param types) - #162106 (Helpful suggestions for incorrect address-of mutability (2)) - #162652 (Syntactically reject leading parenthesized precise capturing lists in bare trait object types (`(use<…>)+`)) - #163337 (MIR move elimination [3/6]: PreciseLiveness) - #163938 (-Zassumptions-on-binders: rewrite alias outlives constraints more goodly) - #163939 (Better debug impls for some assumptions on binders types) - #163954 (fix(bootstrap/darwin): fix rpath for distributed LLD) - #163956 (Pass the unremapped path to the `rustc` invocation for doctests) - #164042 (Allow testing cg-gcc on any target) - #162443 (Do not retain `Normalization` goal errors in nested goals for `BestObligationVisitor:: non_trivial_candidates `) - #162908 (Fix - const parameters rejected when identical) - #163193 (cfi: mangle `f128` as `e` rather than `g` on platforms without `_Float128`) - #163634 (move overflow lint computation into decorator) - #163666 (Updates the expect message library/core/src/time.rs) - #163727 (rigid aliases to non-rigid for fully normalized check) - #163745 (replace `fully_monomorphized` with `cx.typing_env()`) - #163912 (Fix debug assert failure in `note_obligation_cause_code_inner`) - #163950 (don't treat inherited opaques as defining) - #163972 (const-eval: ICE when we hit a non-const fn) - #164000 (When mentioning that closure doesn't implement trait, point at closure) - #164007 ([rustdoc] Prefer local paths over remote ones when foreign item is locally reexported) - #164008 (properly ignore the current goal's usages) - #164017 (cg_llvm: Avoid some explicit casts to `*const c_char`) - #164025 (Less `CanonicalVarValues`)

Rollup merge of #163956 - Urgau:rustdoc-doctest-scopes, r=GuillaumeGomez Pass the unremapped path to the `rustc` invocation for doctests Turns out that `--remap-path-scope` is only half working with doctests, this is because `rustdoc` use a secret environment variable to pass the real filename of the doctest. However we were only passing a remapped path. That means that doctests source path were getting remapped, but only for one scope: `documentation`. It didn't respect `macro` for `file!` for example. To fix this, we have to: 1. pass the local path to the `rustc` invocation 2. have `rustc` treat that path as a real filename and apply remapping per scope to it - I had to add a new `Input` variant, otherwise I can't differentiate normal input `-` from doctests `-` source 4. we have to pass `--remap-path-{prefix,scope}` to `rustc` so the path actually gets remap properly

Urgau added the F-trim-paths Feature: trim-paths label Oct 7, 2026

rustbot assigned GuillaumeGomez Oct 7, 2026

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. labels Oct 7, 2026

Urgau mentioned this pull request Oct 7, 2026

Stabilize --remap-path-scope in rustdoc and the documentation scope #163895

Open

GuillaumeGomez reviewed Oct 8, 2026

View reviewed changes

Comment thread compiler/rustc_driver_impl/src/lib.rs Outdated

GuillaumeGomez approved these changes Oct 8, 2026

View reviewed changes

Correctly represent doctest source as a RealFileName plus line

8f2db6e

Urgau force-pushed the rustdoc-doctest-scopes branch from ff1b312 to 9cf4406 Compare October 8, 2026 20:11

rust-bors Bot 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 Oct 8, 2026

JonathanBrouwer mentioned this pull request Oct 9, 2026

Rollup of 7 pull requests #164015

Closed

JonathanBrouwer mentioned this pull request Oct 9, 2026

Rollup of 11 pull requests #164024

Closed

rust-bors Bot 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-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Oct 9, 2026

Pass --remap-path-{prefix,scope} to the rustc doctest invocation

85b2304

Urgau force-pushed the rustdoc-doctest-scopes branch from 9cf4406 to 85b2304 Compare October 9, 2026 16:11

rust-bors Bot 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-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Oct 9, 2026

This was referenced Oct 9, 2026

Rollup of 10 pull requests #164050

Closed

Rollup of 24 pull requests #164052

Merged

rust-bors Bot merged commit a2170e9 into rust-lang:main Oct 9, 2026
14 checks passed

rustbot added this to the 1.101.0 milestone Oct 9, 2026

This was referenced Oct 10, 2026

Path sanitization for doctests rust-lang/cargo#17554

Open

Tracking Issue for --remap-path-scope in rustdoc #155451

Open

Navigation Menu

Repository navigation

Pass the unremapped path to the `rustc` invocation for doctests - #163956

Pass the unremapped path to the `rustc` invocation for doctests#163956
rust-bors[bot] merged 2 commits into
rust-lang:mainfrom
Urgau:rustdoc-doctest-scopes

Urgau commented Oct 7, 2026

Uh oh!

Uh oh!

GuillaumeGomez left a comment •

edited by rustbot

Loading

Uh oh!

Urgau commented Oct 8, 2026

Uh oh!

rust-bors Bot commented Oct 8, 2026

Uh oh!

JonathanBrouwer commented Oct 9, 2026

Uh oh!

rust-bors Bot commented Oct 9, 2026

Uh oh!

Urgau commented Oct 9, 2026

Uh oh!

rust-bors Bot commented Oct 9, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

Urgau commented Oct 7, 2026

Uh oh!

Uh oh!

GuillaumeGomez left a comment • edited by rustbot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Urgau commented Oct 8, 2026

Uh oh!

rust-bors Bot commented Oct 8, 2026

Uh oh!

JonathanBrouwer commented Oct 9, 2026

Uh oh!

rust-bors Bot commented Oct 9, 2026

Uh oh!

Urgau commented Oct 9, 2026

Uh oh!

rust-bors Bot commented Oct 9, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

GuillaumeGomez left a comment •

edited by rustbot

Loading