diff options
| author | teor <teor@torproject.org> | 2019-12-03 13:28:55 +1000 |
|---|---|---|
| committer | Nick Mathewson <nickm@torproject.org> | 2019-12-04 12:15:22 -0500 |
| commit | b0f1b760aec8fa25fae34be794285fbdfcaaa7e9 (patch) | |
| tree | 62ec0a3cf06083dcfecad049c5140d71852c114a /scripts/maint/practracker/includes.py | |
| parent | 8861ad85d02c10dc7b1add8d1721c5ae48c930b8 (diff) | |
| download | tor-b0f1b760aec8fa25fae34be794285fbdfcaaa7e9.tar.gz tor-b0f1b760aec8fa25fae34be794285fbdfcaaa7e9.zip | |
practracker: document !advisory in includes.py
Diffstat (limited to 'scripts/maint/practracker/includes.py')
| -rwxr-xr-x | scripts/maint/practracker/includes.py | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/scripts/maint/practracker/includes.py b/scripts/maint/practracker/includes.py index 1d43bd58e8..239ea19eaf 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. """ |