From 127abaa937d1e27aaed28ba5f8be74ce4167b4d0 Mon Sep 17 00:00:00 2001
From: xFrednet <xFrednet@gmail.com>
Date: Fri, 1 Apr 2022 19:55:51 +0200
Subject: [PATCH] Add example how lints can be feature gated

---
 src/diagnostics.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/src/diagnostics.md b/src/diagnostics.md
index 3671a0ec..b6752042 100644
--- a/src/diagnostics.md
+++ b/src/diagnostics.md
@@ -594,6 +594,20 @@ declare_lint! {
 This makes the `ANONYMOUS_PARAMETERS` lint allow-by-default in the 2015 edition
 but warn-by-default in the 2018 edition.
 
+### Feature-gated lints
+
+Lints belonging to a feature should only be usable if the feature is enabled in the
+crate. To support this, lint declarations can contain a feature gate like so:
+
+```rust,ignore
+declare_lint! {
+    pub SOME_LINT_NAME,
+    Warn,
+    "a new and useful, but feature gated lint",
+    @feature_gate = sym::feature_name;
+}
+```
+
 ### Future-incompatible lints
 
 The use of the term `future-incompatible` within the compiler has a slightly