about summary refs log tree commit diff
diff options
context:
space:
mode:
-rw-r--r--src/tools/tidy/src/run_make_tests.rs3
1 files changed, 3 insertions, 0 deletions
diff --git a/src/tools/tidy/src/run_make_tests.rs b/src/tools/tidy/src/run_make_tests.rs
index b591f3a7a22..0231ac0939e 100644
--- a/src/tools/tidy/src/run_make_tests.rs
+++ b/src/tools/tidy/src/run_make_tests.rs
@@ -9,6 +9,9 @@ pub fn check(root_path: &Path, bless: bool, bad: &mut bool) {
     let tests_path = &root_path.join("tests");
 
     let allowed_makefiles = {
+        // We use `include!` here which includes the file as Rust syntax because we want to have
+        // a comment that discourages people from adding entries to
+        // `expected_run_make_makefiles.txt` unless *absolutely* necessary.
         let allowed_makefiles = include!("expected_run_make_makefiles.txt");
         let is_sorted = allowed_makefiles.windows(2).all(|w| w[0] < w[1]);
         if !is_sorted && !bless {