diff --git a/src/diagnostics.md b/src/diagnostics.md index 9f4245f28..271130193 100644 --- a/src/diagnostics.md +++ b/src/diagnostics.md @@ -572,7 +572,6 @@ generally based on how they are registered. - *Built-in* lints are defined inside the compiler source. - *Driver-registered* lints are registered when the compiler driver is created by an external driver. This is the mechanism used by Clippy, for example. -- *Plugin* lints are registered by the [deprecated plugin system]. - *Tool* lints are lints with a path prefix like `clippy::` or `rustdoc::`. - *Internal* lints are the `rustc::` scoped tool lints that only run on the rustc source tree itself and are defined in the compiler source like a @@ -581,7 +580,6 @@ generally based on how they are registered. More information about lint registration can be found in the [LintStore] chapter. -[deprecated plugin system]: https://doc.rust-lang.org/nightly/unstable-book/language-features/plugin.html [LintStore]: diagnostics/lintstore.md ### Declaring a lint diff --git a/src/diagnostics/lintstore.md b/src/diagnostics/lintstore.md index 603c9ed65..54dd841ad 100644 --- a/src/diagnostics/lintstore.md +++ b/src/diagnostics/lintstore.md @@ -4,9 +4,8 @@ This page documents some of the machinery around lint registration and how we run lints in the compiler. The [`LintStore`] is the central piece of infrastructure, around which -everything rotates. It's not available during the early parts of compilation -(i.e., before TyCtxt) in most code, as we need to fill it in with all of the -lints, which can only happen after plugin registration. +everything rotates. The `LintStore` is held as part of the [`Session`], and it +gets populated with the list of lints shortly after the `Session` is created. ## Lints vs. lint passes @@ -39,16 +38,15 @@ lints are emitted as part of other work (e.g., type checking, etc.). ### High-level overview -In [`rustc_interface::register_plugins`], +In [`rustc_interface::run_compiler`], the [`LintStore`] is created, and all lints are registered. -There are four 'sources' of lints: +There are three 'sources' of lints: * internal lints: lints only used by the rustc codebase * builtin lints: lints built into the compiler and not provided by some outside source -* plugin lints: lints created by plugins through the plugin system. * `rustc_interface::Config`[`register_lints`]: lints passed into the compiler during construction @@ -56,8 +54,7 @@ Lints are registered via the [`LintStore::register_lint`] function. This should happen just once for any lint, or an ICE will occur. Once the registration is complete, we "freeze" the lint store by placing it in -an `Lrc`. Later in the driver, it's passed into the `GlobalCtxt` constructor -where it lives in an immutable form from then on. +an `Lrc`. Lint passes are registered separately into one of the categories (pre-expansion, early, late, late module). Passes are registered as a closure @@ -68,8 +65,8 @@ they can keep track of state internally. #### Internal lints -These are lints used just by the compiler or plugins like `clippy`. They can be -found in `rustc_lint::internal`. +These are lints used just by the compiler or drivers like `clippy`. They can be +found in [`rustc_lint::internal`]. An example of such a lint is the check that lint passes are implemented using the `declare_lint_pass!` macro and not by hand. This is accomplished with the @@ -92,18 +89,6 @@ the [`rustc_lint::register_builtins`] function. Just like with internal lints, this happens inside of [`rustc_lint::new_lint_store`]. -#### Plugin lints - -This is one of the primary use cases remaining for plugins/drivers. Plugins are -given access to the mutable `LintStore` during registration (which happens -inside of [`rustc_interface::register_plugins`]) and they can call any -functions they need on the `LintStore`, just like rustc code. - -Plugins are intended to declare lints with the `plugin` field set to true -(e.g., by way of the [`declare_tool_lint!`] macro), but this is purely for -diagnostics and help text; otherwise plugin lints are mostly just as first -class as rustc builtin lints. - #### Driver lints These are the lints provided by drivers via the `rustc_interface::Config` @@ -127,7 +112,6 @@ approach, it is beneficial to do so for performance reasons. [`LintStore`]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_lint/struct.LintStore.html [`LintStore::register_lint`]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_lint/struct.LintStore.html#method.register_lints -[`rustc_interface::register_plugins`]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_interface/passes/fn.register_plugins.html [`rustc_lint::register_builtins`]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_lint/fn.register_builtins.html [`rustc_lint::register_internals`]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_lint/fn.register_internals.html [`rustc_lint::new_lint_store`]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_lint/fn.new_lint_store.html @@ -135,3 +119,6 @@ approach, it is beneficial to do so for performance reasons. [`declare_tool_lint!`]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_session/macro.declare_tool_lint.html [`register_lints`]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_interface/interface/struct.Config.html#structfield.register_lints [`&rustc_lint_defs::Lint`]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_lint_defs/struct.Lint.html +[`Session`]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_session/struct.Session.html +[`rustc_interface::run_compiler`]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_interface/index.html#reexport.run_compiler +[`rustc_lint::internal`]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_lint/internal/index.html