1
Fork 0

Improve the docstrings of the Lto struct.

This commit is contained in:
Edd Barrett 2021-04-20 10:19:25 +01:00
parent a70fbf6620
commit 8cc918a3dc

View file

@ -75,19 +75,21 @@ impl_stable_hash_via_hash!(OptLevel);
/// This is what the `LtoCli` values get mapped to after resolving defaults and /// This is what the `LtoCli` values get mapped to after resolving defaults and
/// and taking other command line options into account. /// and taking other command line options into account.
///
/// Note that linker plugin-based LTO is a different mechanism entirely.
#[derive(Clone, PartialEq)] #[derive(Clone, PartialEq)]
pub enum Lto { pub enum Lto {
/// Don't do any LTO whatsoever /// Don't do any LTO whatsoever.
No, No,
/// Do a full crate graph LTO with ThinLTO /// Do a full-crate-graph (inter-crate) LTO with ThinLTO.
Thin, Thin,
/// Do a local graph LTO with ThinLTO (only relevant for multiple codegen /// Do a local ThinLTO (intra-crate, over the CodeGen Units of the local crate only). This is
/// units). /// only relevant if multiple CGUs are used.
ThinLocal, ThinLocal,
/// Do a full crate graph LTO with "fat" LTO /// Do a full-crate-graph (inter-crate) LTO with "fat" LTO.
Fat, Fat,
} }