mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Auto merge of #123336 - workingjubilee:strip-the-trace-off-my-back, r=Nilstrieb

Browse Source 
Note impact of `-Cstrip` on backtraces

It is not always clear to people what the impact of `-Cstrip` options are. They are a common question on sites like StackOverflow, and sometimes people even report bugs with "no backtrace" after deliberately mangling the symbol table. We cannot exhaustively document every permutation, but we should warn people about common effects.
This commit is contained in:
bors 2024-04-02 07:39:10 +00:00
commit 2531d08e34
1 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/doc/rustc/src/codegen-options/index.md
View File

@ -553,9 +553,17 @@ Supported values for this option are:
of MSVC). of MSVC).
- `debuginfo` - debuginfo sections and debuginfo symbols from the symbol table - `debuginfo` - debuginfo sections and debuginfo symbols from the symbol table
section are stripped at link time and are not copied to the produced binary section are stripped at link time and are not copied to the produced binary
or separate files. or separate files. This should leave backtraces mostly-intact but may make
- `symbols` - same as `debuginfo`, but the rest of the symbol table section is using a debugger like gdb or lldb ineffectual.
stripped as well if the linker supports it. - `symbols` - same as `debuginfo`, but the rest of the symbol table section is stripped as well,
depending on platform support. On platforms which depend on this symbol table for backtraces,
profiling, and similar, this can affect them so negatively as to make the trace incomprehensible.
Programs which may be combined with others, such as CLI pipelines and developer tooling,
or even anything which wants crash-reporting, should usually avoid `-Cstrip=symbols`.
Note that, at any level, removing debuginfo only necessarily impacts "friendly" introspection.
`-Cstrip` cannot be relied on as a meaningful security or obfuscation measure, as disassemblers
and decompilers can extract considerable information even in the absence of symbols.
## symbol-mangling-version ## symbol-mangling-version