about summary refs log tree commit diff
path: root/compiler/rustc_session/src
diff options
context:
space:
mode:
authorEdd Barrett <vext01@gmail.com>2021-04-20 10:19:25 +0100
committerEdd Barrett <vext01@gmail.com>2021-04-20 10:28:17 +0100
commit8cc918a3dca757c6ea649f7d5d2aed963668bb38 (patch)
tree593f860d8e74090f4b38293dfd9c1af3f964ebf8 /compiler/rustc_session/src
parenta70fbf6620ddaacc2ef805fa8c4ac2dc9bf02f3c (diff)
downloadrust-8cc918a3dca757c6ea649f7d5d2aed963668bb38.tar.gz
rust-8cc918a3dca757c6ea649f7d5d2aed963668bb38.zip
Improve the docstrings of the `Lto` struct.
Diffstat (limited to 'compiler/rustc_session/src')
-rw-r--r--compiler/rustc_session/src/config.rs12
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,
 }