about summary refs log tree commit diff
path: root/src/librustc_interface/interface.rs
diff options
context:
space:
mode:
authorMark Rousskov <mark.simulacrum@gmail.com>2019-10-22 16:53:28 -0400
committerMark Rousskov <mark.simulacrum@gmail.com>2019-10-22 16:53:28 -0400
commit4e8d1b229217c7c83ce96b44410ccae9470db973 (patch)
tree1ed442ba2b1abe9a515cb283881bc6e0233fa125 /src/librustc_interface/interface.rs
parent6be0a7081a9aafc4e0b39cae266fbed5eabd8993 (diff)
downloadrust-4e8d1b229217c7c83ce96b44410ccae9470db973.tar.gz
rust-4e8d1b229217c7c83ce96b44410ccae9470db973.zip
Add some documentation
Diffstat (limited to 'src/librustc_interface/interface.rs')
-rw-r--r--src/librustc_interface/interface.rs5
1 files changed, 5 insertions, 0 deletions
diff --git a/src/librustc_interface/interface.rs b/src/librustc_interface/interface.rs
index 34ec3c862a3..3f832f95bd4 100644
--- a/src/librustc_interface/interface.rs
+++ b/src/librustc_interface/interface.rs
@@ -82,6 +82,11 @@ pub struct Config {
     pub crate_name: Option<String>,
     pub lint_caps: FxHashMap<lint::LintId, lint::Level>,
 
+    /// This is a callback from the driver that is called when we're registering lints;
+    /// it is called during plugin registration when we have the LintStore in a non-shared state.
+    ///
+    /// Note that if you find a Some here you probably want to call that function in the new
+    /// function being registered.
     pub register_lints: Option<Box<dyn Fn(&Session, &mut lint::LintStore) + Send + Sync>>,
 }