[tor-commits] [tor/master] practracker: document !advisory in includes.py

nickm at torproject.org nickm at torproject.org
Wed Dec 4 17:15:37 UTC 2019


commit b0f1b760aec8fa25fae34be794285fbdfcaaa7e9
Author: teor <teor at torproject.org>
Date:   Tue Dec 3 13:28:55 2019 +1000

    practracker: document !advisory in includes.py
---
 scripts/maint/practracker/includes.py | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/scripts/maint/practracker/includes.py b/scripts/maint/practracker/includes.py
index 1d43bd58e..239ea19ea 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.
 """
 
 





More information about the tor-commits mailing list