Repository navigation
fix(trim-paths)!: remove default scope from release profile - #17424
Merged
Merged
Conversation
rustbot
added
A-documenting-cargo-itself
rustbot
added
the
S-waiting-on-review
Collaborator
|
r? @epage rustbot has assigned @epage. Use Why was this reviewer chosen?The reviewer was selected based on:
|
weihanglo
force-pushed
the
trim-path-release
branch
from
September 2, 2026 04:32
a9532f3 to
5675e04
Compare
This is a stabilization preparation. A saner default is still wanted in the future maybe in a new edition.
weihanglo
force-pushed
the
trim-path-release
branch
from
September 2, 2026 05:32
5675e04 to
c8b5382
Compare
epage
approved these changes
Sep 2, 2026
Contributor
|
Note that profiles are config or workspace scoped and Editions are generally not able to impact them. |
rustbot
removed
the
S-waiting-on-review
Member
Author
Hmm… good point. That make the transition a bit harder. As we have plans to change the default for the |
Contributor
|
We've made profile changes before. I think the question is what would be broken and how bad. |
14 of 19 tasks
pull Bot
pushed a commit
to Mattlk13/cargo
that referenced
this pull request
Sep 2, 2026
### What does this PR try to resolve? This doc polish is a stabilization preparation. See <rust-lang#12137 (comment)> ### How to test and review this PR? This is stacked on top of <rust-lang#17424> to minimize merge conflict. Please review from c99bbf2 ``` mdbook serve doc/book ```
rust-bors Bot
pushed a commit
to rust-lang/rust
that referenced
this pull request
Sep 2, 2026
Update cargo submodule 26 commits in e8cb624d5701824f46a2ec5873cfd59ee3d2f66c..b2e9d5f9db3fb1c454ab84f10c16508984a266e2 2026-08-22 00:23:45 +0000 to 2026-09-02 14:49:16 +0000 - fix(parser): Resolve theoretical use-after-free (rust-lang/cargo#17428) - fix(trim-paths)!: remove default scope from release profile (rust-lang/cargo#17424) - fix(git): Use git's 429 retry, when available (rust-lang/cargo#17422) - Avoid passing search path (-L) args when they are passed as --extern (rust-lang/cargo#17410) - chore(deps): update crate-ci/typos action to v1.50.0 (rust-lang/cargo#17417) - test: Move -Z onto its own line (rust-lang/cargo#17416) - chore(triagebot): enable `@rustbot merge/delegate` (rust-lang/cargo#17415) - Micro-optimize two package dir functions (rust-lang/cargo#17413) - perf: Do not build SBOM if user has not set build.sbom (rust-lang/cargo#17412) - feat(manifest)!: implement feature-metadata RFC3416 (rust-lang/cargo#15056) - Cargo profiling improvements (rust-lang/cargo#17411) - test(git): Remove gix override run in CI and the mode in code (rust-lang/cargo#17405) - perf(git): Reduce extra work when using git-cli (rust-lang/cargo#17406) - feat(resolver): Stabilize min-publish-age (rust-lang/cargo#17335) - fix(git): Remove ref status update when showing progress (rust-lang/cargo#17400) - revert: refactor: move sysroot lookup to GlobalContext (rust-lang/cargo#17401) - fix(run): Printing a new line to avoid overwriting error code after \r (rust-lang/cargo#17373) - fix(trim-paths): custom workspace-relative member paths remap (rust-lang/cargo#17366) - fix(home): rustdoc lint (rust-lang/cargo#17394) - feat(diag): Stabilize cargo-lints (rust-lang/cargo#17298) - chore(deps): Update partial_ref to v0.3.4 (rust-lang/cargo#17392) - refactor: remove ad-hoc `subslice_range` (rust-lang/cargo#17390) - docs(changelog): move build-dir new layout to Changed (rust-lang/cargo#17387) - chore(deps): update msrv (1 version) to v1.98 (rust-lang/cargo#17386) - docs: Use mdbook admonitions (rust-lang/cargo#17384) - chore(ci): exclude resolver-tests from intra doc link checks (rust-lang/cargo#17385)
linus-mullvad
added a commit
to mullvad/mullvadvpn-app
that referenced
this pull request
Sep 16, 2026
Cargo removed the default "object" scope from the release profile in rust-lang/cargo#17424, so enabling the feature in .cargo/config.toml no longer trims anything, silently. The scope has to be set per profile, and that key cannot be committed to .cargo/config.toml because stable cargo rejects it rather than ignoring it.
linus-mullvad
added a commit
to mullvad/mullvadvpn-app
that referenced
this pull request
Sep 16, 2026
Cargo removed the default "object" scope from the release profile in rust-lang/cargo#17424, so enabling the feature in .cargo/config.toml no longer trims anything, silently. The scope has to be set per profile, and that key cannot be committed to .cargo/config.toml because stable cargo rejects it rather than ignoring it.
3 of 6 tasks
github-actions Bot
pushed a commit
to codeandsolder/cargo-ephemeral
that referenced
this pull request
Oct 6, 2026
*[View all comments](https://triagebot.infra.rust-lang.org/gh-comments/rust-lang/cargo/pull/17488)* # Stabilization report: `profile.trim-paths` Resolves rust-lang#12137 Resolves rust-lang/rust#111540 RFC: <https://rust-lang.github.io/rfcs/3127-trim-paths.html> ## What is stabilized The rustc side `--remap-path-scope` was already stabilized in Rust 1.95 via rust-lang/rust#147611 This stabilizes the Cargo side: * `profile.<name>.trim-paths = "none" | "object" | "all"` in both manifest and config * The remap rules of how Cargo passes `--remap-path-{prefix,scope}`. The exact remap prefixes still stay unspecified. * The unremap file `<artifact>.trim-paths.json` (schema v1), which is emitted beside final artifacts when debuginfo is on. * `CARGO_TRIM_PATHS_SCOPE` and `CARGO_TRIM_PATHS_REMAP` for build scripts. When this is merged and sync in rust-lang/rust, we'll also stabilize * The `rust-gdb` and `rust-lldb` unremap loaders. `RUST_GDB_TRIM_PATHS=unstable` and `RUST_LLDB_TRIM_PATHS=unstable` are not needed anymore. See doc for details: https://github.com/rust-lang/cargo/blob/8814ead110e36ed8fdcf1fdd4009baf82bd78523/doc/book/src/reference/unstable.md?plain=1#L1441-L1645 ## What is not stabilized / included * This doesn't guarantee full sanitization. It is a best-effort feature. * Other `--remap-path-scope` values in rustc (`macro`, `diagnostics`, `debuginfo`, `coverage`), boolean values, and comma-separated list options. These are removed in rust-lang#17432. They can come back later when needed. * A default trim-path value for built-in profiles. RFC originall proposed to set `release` to `"object"`. This is left for future when this is more adopted and battle-tested. We have loose stability guarantee for changing profile settings anyway. * `__CARGO_RUSTC_BOOTSTRAP_WS_REMAP`. This stays as an internal thing between rustc bootstrap and cargo (see rust-lang#17349, rust-lang#17366) * Doctest remapping and `documentation` scope. This will be integrated in the future incrementally when those scopes and features are stable. * The exact remap prefixes are unspecified as documented. However, in practice, rustc bootstrap and debugger depend on the stabilized shape, so any change needs careful coordination with them. * Unremap files for artifact deps: deferred, non-blocking. * `build-rs` API for the two build script variables: deferred, non-blocking. * If there are new kinds of artifacts, we can decide whether to remap freely. ### Doors closed * The trim-paths profile key name, its shape, and its options. * The unremap file name suffix `.trim-paths.json` and the v1 schema. * The environment variable `CARGO_TRIM_PATHS_SCOPE` and `CARGO_TRIM_PATHS_REMAP`. ## Post-RFC changes * rustc removed `split-debuginfo` scopes, and Cargo followed and stopped caring split debuginfo. * The RFC remapped the current package to relative paths and every dependency to `<name>-<version>`. In rust-lang#17302 we chose workspace members relative remap, so debuggers resolve workspace sources with zero configuration. The RFC worried that relative paths only work when running from the right directory, and symbolication tools need a second process for joining workspace relative paths. THe unremap file has `workspace_root`, so the join is fairly mechanical. Remap prefixes are unspecified anyway, so we can still change if it turns out not ideal. * The unremap file is new (introduced in rust-lang#17303), for helping debugging find sources, as well as our keeping remap rules unspecified. The RFC had no answer about this. * `CARGO_TRIM_PATHS_REMAP` build script env is new. It lets build scripts forward the same rules to C/C++ compilers to flags like `-fmacro-prefix-map`. `cc-rs` has integrated that since rust-lang/cc-rs#1794. ## Feedback * rustc bootstrap builds the compiler and standard library with `trim-paths` via rust-lang/rust#161049 since 2026-09-02. This exercises the sysroot remap and the workspace prefix override in rust-lang/rust CI. * `cc-rs` forwards the remap rules to C/C++ compiler since 1.3.0: <https://github.com/rust-lang/cc-rs/releases/tag/cc-v1.3.0> * Zulip thread: [#t-cargo > stabilization plan for &rust-lang#96;-Ztrim-paths&rust-lang#96;](https://rust-lang.zulipchat.com/#narrow/channel/246057-t-cargo/topic/stabilization.20plan.20for.20.60-Ztrim-paths.60/with/622955580) * Call for testing posted on 2026-09-09 * rust-lang#12137 (comment) * Included in TWiR issue 669 <https://this-week-in-rust.org/blog/2026/09/16/this-week-in-rust-669/> ## Known limitations This sanitization is best-effort. See * rustc: <https://doc.rust-lang.org/rustc/remap-source-paths.html#caveats-and-limitations> * Cargo: <https://github.com/rust-lang/cargo/blob/8814ead110e36ed8fdcf1fdd4009baf82bd78523/doc/book/src/reference/unstable.md?plain=1#L1603-L1626> ## Implementation ### History | PR | Merged | Title | |--------|------------|-------------------------------------------------| | rust-lang#12625 | 2023-10-31 | implement RFC 3127 `-Ztrim-paths` | | rust-lang#12900 | 2023-10-31 | set env `CARGO_TRIM_PATHS` for build scripts | | rust-lang#12908 | 2023-11-02 | merge `trim-paths` from different profiles | | rust-lang#13118 | 2023-12-06 | assert `OSO` and `SO` cannot be trimmed | | rust-lang#14389 | 2024-08-12 | rustdoc supports trim-paths for diagnostics | | rust-lang#14908 | 2024-12-09 | use Path::push to construct remap-path-prefix | | rust-lang#14917 | 2024-12-11 | use stable hash from rustc-stable-hash | | rust-lang#15614 | 2025-06-02 | remap all paths to `build.build-dir` | | rust-lang#15621 | 2025-06-02 | enable more tests for windows-msvc | | rust-lang#16536 | 2026-01-21 | `--remap-path-scope` stabilized in 1.95-nightly | | rust-lang#17104 | 2026-06-15 | emit `CARGO_TRIM_PATHS_REMAP` for build.rs | | rust-lang#17221 | 2026-07-15 | exercise GDB on windows-gnu | | rust-lang#17302 | 2026-08-03 | unambiguous and reversible remap rules | | rust-lang#17303 | 2026-08-04 | emit unremap files for final artifacts | | rust-lang#17326 | 2026-08-07 | exercise unremap files with debuggers | | rust-lang#17338 | 2026-08-08 | `/cargo/deps` fallback sources | | rust-lang#17337 | 2026-08-10 | workspace remap under -Zroot-dir | | rust-lang#17349 | 2026-08-11 | honor workspace prefix override from env | | rust-lang#17366 | 2026-08-26 | custom workspace-relative member paths remap | | rust-lang#17424 | 2026-09-02 | remove default scope from release profile | | rust-lang#17425 | 2026-09-02 | docs: add limitations and polish | | rust-lang#17432 | 2026-09-04 | limit options to `none\|object\|all` | | rust-lang#17476 | 2026-09-15 | unremap file in one JSON doc | | rust-lang#17491 | 2026-09-21 | `build-rs` support | ### Test coverage * Remap for each dependency kind * `"object"` with every `split-debuginfo` mode * `"all"` diagnostics remapping for rustc and rustdoc * The new build-script environment variables. * Real world debugger exercises with GDB, LLDB, and CDB * unremap files with rebuilds, `cargo clean`, JSON messages * rustc bootstrap workspace prefix override * `-Zbuild-std` backtraces show `/rustc/<hash>` paths ## Follow-ups after stabilization * [ ] Revisit reproducibility issues, such as * rust-lang#13586 * rust-lang#15122 * rust-lang#7645 * rust-lang#10915 Absolute paths of workspace and `CARGO_HOME` still get into `-Cmetadata`/`-Cextra-filename`/fingerprints. With `trim-paths = "object"` we might be able to also trim paths in those places. * [ ] Revisit a new default for built-in profiles e.g., `release` * [ ] In rust-lang/rust stabilize loader logic in `src/etc/gdb_trim_paths.py` and `src/etc/lldb_trim_paths.py` * [x] A new issue for `build-rs` adding `CARGO_TRIM_PATHS_SCOPE` and `CARGO_TRIM_PATHS_REMAP` support * [ ] A new issue for supporting doctest remapping and documentation scope. * [ ] Track unremap files support in artifact dependencies tracking issue --- 🤖 LLM disclosure: impl history was generated. heading was generated. meats are human-written.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
What does this PR try to resolve?
This is a stabilization preparation.
A saner default is still wanted in the future maybe in a new edition.
See #12137 (comment)