summaryrefslogtreecommitdiff
path: root/scripts/maint/practracker/includes.py
diff options
context:
space:
mode:
Diffstat (limited to 'scripts/maint/practracker/includes.py')
-rwxr-xr-xscripts/maint/practracker/includes.py4
1 files changed, 4 insertions, 0 deletions
diff --git a/scripts/maint/practracker/includes.py b/scripts/maint/practracker/includes.py
index f2d91b63a1..ed0e11ef28 100755
--- a/scripts/maint/practracker/includes.py
+++ b/scripts/maint/practracker/includes.py
@@ -13,6 +13,10 @@
file in each directory. This file contains empty lines, #-prefixed
comments, filenames (like "lib/foo/bar.h") and file globs (like lib/*/*.h)
for files that are permitted.
+
+ The script exits with an error if any non-permitted includes are found.
+ .may_include files that contain "!advisory" are considered advisory.
+ Advisory .may_include files only result in warnings, rather than errors.
"""