Skip to content

Commit

Permalink
Auto merge of rust-lang#123336 - workingjubilee:strip-the-trace-off-m…
Browse files Browse the repository at this point in the history
…y-back, r=Nilstrieb

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.
  • Loading branch information
bors committed Apr 2, 2024
2 parents e2cf2cb + 1dcaf70 commit 2531d08
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions src/doc/rustc/src/codegen-options/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -553,9 +553,17 @@ Supported values for this option are:
of MSVC).
- `debuginfo` - debuginfo sections and debuginfo symbols from the symbol table
section are stripped at link time and are not copied to the produced binary
or separate files.
- `symbols` - same as `debuginfo`, but the rest of the symbol table section is
stripped as well if the linker supports it.
or separate files. This should leave backtraces mostly-intact but may make
using a debugger like gdb or lldb ineffectual.
- `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

Expand Down

0 comments on commit 2531d08

Please sign in to comment.