practracker: document !advisory in includes.py

diff --git a/scripts/maint/practracker/includes.py b/scripts/maint/practracker/includes.py
index 1d43bd58e8a5c2323e6387e8c654eb38e4e84a41..239ea19eaf502948bf079887324e0c15d4ab621c 100755 (executable)
--- 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.
 """