From 71ff28a31d65d5872032e4809d211c3bf6ea65df Mon Sep 17 00:00:00 2001 From: Jubilee Young Date: Sun, 31 Mar 2024 19:19:10 -0700 Subject: [PATCH] Document variance in strip Two variances in strip will remain, even after MSVC shenanigans settle: - Its default based on profile. - That it can sometimes make backtraces nonsensical. In my experience, people will complain to me if backtraces are fucked up, but sometimes it was their own decision to make the backtrace really bad. Inform them of this. Hopefully this also encourages people to report if their backtraces regress in some platform-dependent way without enabling `strip = "symbols"`, which we would want to know about. --- src/doc/src/reference/profiles.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/doc/src/reference/profiles.md b/src/doc/src/reference/profiles.md index fac84f8363e..4e1696d3562 100644 --- a/src/doc/src/reference/profiles.md +++ b/src/doc/src/reference/profiles.md @@ -117,7 +117,9 @@ strip = "debuginfo" ``` Possible string values of `strip` are `"none"`, `"debuginfo"`, and `"symbols"`. -The default is `"none"`. +The default is `"none"` by default, and `"debuginfo"` in release profile. +Be aware that stripping `"symbols"` may make backtraces incomprehensible, +depending on the platform. You can also configure this option with the boolean values `true` or `false`. `strip = true` is equivalent to `strip = "symbols"`. `strip = false` is @@ -293,7 +295,7 @@ The default settings for the `release` profile are: opt-level = 3 debug = false split-debuginfo = '...' # Platform-specific. -strip = "none" +strip = "debuginfo" debug-assertions = false overflow-checks = false lto = false