diff options
| author | Zalathar <Zalathar@users.noreply.github.com> | 2025-01-16 12:53:46 +1100 |
|---|---|---|
| committer | Zalathar <Zalathar@users.noreply.github.com> | 2025-01-16 15:43:29 +1100 |
| commit | 2238b00dac093dce9614ead293cbc3fe66577787 (patch) | |
| tree | a097312f9503968714f9295e2cac4d31e75a5272 /src/doc | |
| parent | 419b3e2d3e350822550eee0e82eeded4d324d584 (diff) | |
| download | rust-2238b00dac093dce9614ead293cbc3fe66577787.tar.gz rust-2238b00dac093dce9614ead293cbc3fe66577787.zip | |
Update docs for `-Clink-dead-code` to discourage its use
Diffstat (limited to 'src/doc')
| -rw-r--r-- | src/doc/rustc/src/codegen-options/index.md | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/src/doc/rustc/src/codegen-options/index.md b/src/doc/rustc/src/codegen-options/index.md index e987d06b0f3..f45217c69ff 100644 --- a/src/doc/rustc/src/codegen-options/index.md +++ b/src/doc/rustc/src/codegen-options/index.md @@ -207,14 +207,14 @@ options should be separated by spaces. ## link-dead-code -This flag controls whether the linker will keep dead code. It takes one of -the following values: +Tries to generate and link dead code that would otherwise not be generated or +linked. It takes one of the following values: -* `y`, `yes`, `on`, `true` or no value: keep dead code. +* `y`, `yes`, `on`, `true` or no value: try to keep dead code. * `n`, `no`, `off` or `false`: remove dead code (the default). -An example of when this flag might be useful is when trying to construct code coverage -metrics. +This flag was historically used to help improve some older forms of code +coverage measurement. Its use is not recommended. ## link-self-contained |