tor/scripts/maint/practracker
2020-01-14 17:41:44 +10:00
..
testdata practracker: Test for bad ".c" includes in the unit tests 2019-12-04 12:15:22 -05:00
.enable_practracker_in_hooks maint-0.4.2: remove ".enable_practracker_in_hooks". 2019-10-11 17:18:55 -04:00
exceptions.txt Merge branch 'stream-socks-auth' into bug19859_merged 2019-11-25 07:58:02 -05:00
includes.py python: Add __future__ imports for python 3 compatibility 2019-12-12 15:58:51 +10:00
metrics.py python: Add __future__ imports for python 3 compatibility 2019-12-12 15:58:51 +10:00
practracker_tests.py python: Add __future__ imports for python 3 compatibility 2019-12-12 15:58:51 +10:00
practracker.py Merge branch 'maint-0.4.2' 2020-01-14 17:41:44 +10:00
problem.py python: Add __future__ imports for python 3 compatibility 2019-12-12 15:58:51 +10: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 python: Add __future__ imports for python 3 compatibility 2019-12-12 15:58:51 +10: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".