From b0f1b760aec8fa25fae34be794285fbdfcaaa7e9 Mon Sep 17 00:00:00 2001
From: teor <teor@torproject.org>
Date: Tue, 3 Dec 2019 13:28:55 +1000
Subject: [PATCH] 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 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.
"""
--
GitLab