tor/scripts/maint/practracker
teor 7e111d0eaa
practracker: print a notice to stderr when disabled
When TOR_DISABLE_PRACTRACKER is set, print a message to
stderr when skipping practracker checks.

Part of 32705.
2020-01-14 17:41:00 +10:00
..
testdata practracker: Integration test for --list-overbroad 2019-09-18 10:28:33 -04:00
exceptions.txt Bump practracker exception limit for process_win32_exec(). 2019-10-17 21:12:51 +02:00
includes.py practracker: make filename terminology uniform 2019-08-29 09:20:27 -04:00
metrics.py practracker: handle empty files. 2019-09-02 15:40:35 -04:00
practracker_tests.py Port practracker unit tests to python 3 2019-08-01 14:00:48 -04:00
practracker.py practracker: print a notice to stderr when disabled 2020-01-14 17:41:00 +10:00
problem.py practracker: An exception is "used" even when it is violated. 2019-09-18 10:28:33 -04:00
README practracker: make filename terminology uniform 2019-08-29 09:20:27 -04:00
test_practracker.sh test_practracker.sh: never disable practracker 2020-01-13 16:17:51 -05:00
util.py Practracker: do not list problems when told to --list-overbroad. 2019-09-18 10:28:33 -04:00

Practracker is a simple python tool that keeps track of places where
our code is ugly, and tries to warn us about new ones or ones that
get worse.

Right now, practracker looks for the following kinds of
best-practices violations:

  .c files greater than 3000 lines long
  .h files greater than 500 lines long
  .c files with more than 50 includes
  .h files with more than 15 includes

  All files that include a local header not listed in a .may_include
  file in the same directory, when that .may_include file has an
  "!advisory" marker.

The list of current violations is tracked in exceptions.txt; slight
deviations of the current exceptions cause warnings, whereas large
ones cause practracker to fail.

For usage information, run "practracker.py --help".