about summary refs log tree commit diff
path: root/compiler/rustc_interface/src
diff options
context:
space:
mode:
authorNicholas Nethercote <n.nethercote@gmail.com>2022-10-11 11:43:25 +1100
committerNicholas Nethercote <n.nethercote@gmail.com>2022-10-19 17:37:50 +1100
commit5d716fd0e96c4408ad13e5e82df364fb1e984540 (patch)
tree83b47ffc3d6b52afa493f4c50fd1a580dd84d47d /compiler/rustc_interface/src
parentcf13d9143d2a907120682fe3d6e59249a21cb0ca (diff)
downloadrust-5d716fd0e96c4408ad13e5e82df364fb1e984540.tar.gz
rust-5d716fd0e96c4408ad13e5e82df364fb1e984540.zip
Add a comment to `Compiler`.
It took me a while to work this out.
Diffstat (limited to 'compiler/rustc_interface/src')
-rw-r--r--compiler/rustc_interface/src/interface.rs5
1 files changed, 4 insertions, 1 deletions
diff --git a/compiler/rustc_interface/src/interface.rs b/compiler/rustc_interface/src/interface.rs
index a3bf7cde9ff..89aaa0b95e4 100644
--- a/compiler/rustc_interface/src/interface.rs
+++ b/compiler/rustc_interface/src/interface.rs
@@ -25,7 +25,10 @@ use std::result;
 
 pub type Result<T> = result::Result<T, ErrorGuaranteed>;
 
-/// Represents a compiler session.
+/// Represents a compiler session. Note that every `Compiler` contains a
+/// `Session`, but `Compiler` also contains some things that cannot be in
+/// `Session`, due to `Session` being in a crate that has many fewer
+/// dependencies than this crate.
 ///
 /// Can be used to run `rustc_interface` queries.
 /// Created by passing [`Config`] to [`run_compiler`].