diff options
| author | Mara Bos <m-ou.se@m-ou.se> | 2021-04-21 23:06:17 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-04-21 23:06:17 +0200 |
| commit | 6967b68667e96f533daa6cb6d0e2f8ba3203db53 (patch) | |
| tree | 1ae4751ed70637d8b7ed19697152f20de439ee57 | |
| parent | d341851f94c0162acf652aa31247e3e6ad9f6c65 (diff) | |
| parent | 8cc918a3dca757c6ea649f7d5d2aed963668bb38 (diff) | |
| download | rust-6967b68667e96f533daa6cb6d0e2f8ba3203db53.tar.gz rust-6967b68667e96f533daa6cb6d0e2f8ba3203db53.zip | |
Rollup merge of #84365 - vext01:improve-lto-docstrings, r=petrochenkov
Improve the docstrings of the `Lto` struct. This change is the result of [this zulip discussion](https://rust-lang.zulipchat.com/#narrow/stream/182449-t-compiler.2Fhelp/topic/Making.20sense.20of.20LTO.20modes.20in.20rustc). Hopefully it makes things a little clearer. What do you think?
| -rw-r--r-- | compiler/rustc_session/src/config.rs | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/compiler/rustc_session/src/config.rs b/compiler/rustc_session/src/config.rs index b6b349e4a80..b683626bbd6 100644 --- a/compiler/rustc_session/src/config.rs +++ b/compiler/rustc_session/src/config.rs @@ -75,19 +75,21 @@ impl_stable_hash_via_hash!(OptLevel); /// This is what the `LtoCli` values get mapped to after resolving defaults and /// and taking other command line options into account. +/// +/// Note that linker plugin-based LTO is a different mechanism entirely. #[derive(Clone, PartialEq)] pub enum Lto { - /// Don't do any LTO whatsoever + /// Don't do any LTO whatsoever. No, - /// Do a full crate graph LTO with ThinLTO + /// Do a full-crate-graph (inter-crate) LTO with ThinLTO. Thin, - /// Do a local graph LTO with ThinLTO (only relevant for multiple codegen - /// units). + /// Do a local ThinLTO (intra-crate, over the CodeGen Units of the local crate only). This is + /// only relevant if multiple CGUs are used. ThinLocal, - /// Do a full crate graph LTO with "fat" LTO + /// Do a full-crate-graph (inter-crate) LTO with "fat" LTO. Fat, } |
