Comment that lint_configuration.md is machine generated

rust-lang · Jan 14, 2023 · c0da8ac · c0da8ac
1 parent d950279
commit c0da8ac
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 1 deletion.
diff --git a/book/src/lint_configuration.md b/book/src/lint_configuration.md
@@ -1,3 +1,8 @@
+<!--
+This file is generated by `cargo collect-metadata`.
+Please use that command to update the file and do not edit it by hand.
+-->
+
 ## Lint Configuration Options
 | <div style="width:290px">Option</div> | Default Value |
 |--|--|

diff --git a/clippy_lints/src/utils/internal_lints/metadata_collector.rs b/clippy_lints/src/utils/internal_lints/metadata_collector.rs
@@ -239,7 +239,17 @@ impl Drop for MetadataCollector {
             .create(true)
             .open(MARKDOWN_OUTPUT_FILE)
             .unwrap();
-        writeln!(file, "{}", self.get_markdown_docs(),).unwrap();
+        writeln!(
+            file,
+            "<!--
+This file is generated by `cargo collect-metadata`.
+Please use that command to update the file and do not edit it by hand.
+-->
+
+{}",
+            self.get_markdown_docs(),
+        )
+        .unwrap();
     }
 }