Merge pull request #3081 from mikerite/fix-3078

[rust.git] / build.rs

diff --git a/build.rs b/build.rs
index 1c930c1b2c95e531928f002e295c50f0eb31d782..3b9f217c8848fa968dd5a70092ad2284c0f7ad78 100644 (file)
--- a/build.rs
+++ b/build.rs
@@ -1,3 +1,18 @@
+//! This build script ensures that Clippy is not compiled with an
+//! incompatible version of rust. It will panic with a descriptive
+//! error message instead.
+//!
+//! We specifially want to ensure that Clippy is only built with a
+//! rustc version that is newer or equal to the one specified in the
+//! `min_version.txt` file.
+//!
+//! `min_version.txt` is in the repo but also in the `.gitignore` to
+//! make sure that it is not updated manually by accident. Only CI
+//! should update that file.
+//!
+//! This build script was originally taken from the Rocket web framework:
+//! https://github.com/SergioBenitez/Rocket
+
 use std::env;
 
 fn main() {