commit cfa028291e036c06d65608de903b3f1dd3d4f334
author Hoa Nguyen <hoanguyen@ucdavis.edu> Mon Jun 07 12:21:05 2021 -0700
committer Hoa Nguyen <hoanguyen@ucdavis.edu> Tue Jun 08 06:23:02 2021 +0000
tree 7eeb1f75fc2a9a6c01f1a8d992a1f1d6dd0eb9d7
parent 59879e3794c4da69c272a58f11e01d9c510cd21d

util: Make sorted includes verifier less confusing

verifiers.py complains about unordered includes where there is
more than one empty line under the #include region, even if
the includes are sorted.

This change adds a note about the fact.

Change-Id: I7a8dbc12fd82db0f0cadcfec270e42f6e0de4aea
Signed-off-by: Hoa Nguyen <hoanguyen@ucdavis.edu>
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/46580
Reviewed-by: Jason Lowe-Power <power.jg@gmail.com>
Maintainer: Jason Lowe-Power <power.jg@gmail.com>
Tested-by: kokoro <noreply+kokoro@google.com>

util/style/verifiers.py

diff --git a/util/style/verifiers.py b/util/style/verifiers.py
index efc347e..7ab7344 100644
--- a/util/style/verifiers.py
+++ b/util/style/verifiers.py
@@ -361,8 +361,10 @@
 
         if modified:
             if not silent:
-                self.ui.write("invalid sorting of includes in %s\n"
-                                % (filename))
+                self.ui.write("invalid sorting of includes in %s. Note: If "
+                              "there is more than one empty line under the "
+                              "#include region, please reduce it to one.\n"
+                              % (filename))
                 if self.ui.verbose:
                     for start, end in modified.regions:
                         self.ui.write("bad region [%d, %d)\n" % (start, end))