about summary refs log tree commit diff
diff options
context:
space:
mode:
authorJubilee Young <workingjubilee@gmail.com>2024-04-01 13:50:29 -0700
committerJubilee Young <workingjubilee@gmail.com>2024-04-01 13:50:29 -0700
commit973663db9dbff6c9fda1ad79884cff5a1675cb06 (patch)
treef5017c678c180e13d810319ca76ce29f614ea82d
parent3896f0762715092a4f6dfc81b38ba69080192bcd (diff)
downloadrust-973663db9dbff6c9fda1ad79884cff5a1675cb06.tar.gz
rust-973663db9dbff6c9fda1ad79884cff5a1675cb06.zip
Discourage stripping symbols in devtools
-rw-r--r--src/doc/rustc/src/codegen-options/index.md6
1 files changed, 4 insertions, 2 deletions
diff --git a/src/doc/rustc/src/codegen-options/index.md b/src/doc/rustc/src/codegen-options/index.md
index 5667f0e02ce..36335abb525 100644
--- a/src/doc/rustc/src/codegen-options/index.md
+++ b/src/doc/rustc/src/codegen-options/index.md
@@ -557,8 +557,10 @@ Supported values for this option are:
   using a debugger like gdb or lldb ineffectual.
 - `symbols` - same as `debuginfo`, but the rest of the symbol table section is
   stripped as well if the linker supports it. On platforms which depend on the
-  binary's symbol table for backtraces, this can affect them so negatively as to
-  make the trace completely incomprehensible.
+  binary's symbol table for backtraces, profiling, and similar, this can affect
+  them so negatively as to make the results completely incomprehensible.
+  Programs which may be combined with others, using e.g. CLI pipelines, or any
+  developer tooling whatsoever, should avoid stripping symbols for this reason.
 
 ## symbol-mangling-version