about summary refs log tree commit diff
path: root/compiler/rustc_session/src
diff options
context:
space:
mode:
authorDianQK <dianqk@dianqk.net>2025-01-08 22:50:04 +0800
committerDianQK <dianqk@dianqk.net>2025-02-23 21:23:38 +0800
commitf32ca1afafa6dbe565b7209067f29c8cf9d074c3 (patch)
tree8940fda46f7201c47c9542adf9255824472ecbf3 /compiler/rustc_session/src
parent1a99ca8da98061a52b9b429d1a859b1e1475cae9 (diff)
downloadrust-f32ca1afafa6dbe565b7209067f29c8cf9d074c3.tar.gz
rust-f32ca1afafa6dbe565b7209067f29c8cf9d074c3.zip
Document bitcode in `OutputType`
Diffstat (limited to 'compiler/rustc_session/src')
-rw-r--r--compiler/rustc_session/src/config.rs5
1 files changed, 5 insertions, 0 deletions
diff --git a/compiler/rustc_session/src/config.rs b/compiler/rustc_session/src/config.rs
index d94338443b3..23553a5540c 100644
--- a/compiler/rustc_session/src/config.rs
+++ b/compiler/rustc_session/src/config.rs
@@ -539,8 +539,13 @@ impl FromStr for SplitDwarfKind {
 #[derive(Clone, Copy, PartialEq, Eq, Hash, Debug, PartialOrd, Ord, HashStable_Generic)]
 #[derive(Encodable, Decodable)]
 pub enum OutputType {
+    /// This is the optimized bitcode, which could be either pre-LTO or non-LTO bitcode,
+    /// depending on the specific request type.
     Bitcode,
+    /// This is the summary or index data part of the ThinLTO bitcode.
     ThinLinkBitcode,
+    /// This is ThinLTO's pre-link bitcode, primarily used for embedding bitcode in object files.
+    /// This can also be used for FatLTO.
     ThinBitcode,
     Assembly,
     LlvmAssembly,