tor/scripts/maint/practracker
2019-08-21 10:17:26 -04:00
..
testdata Practracker: add an integration test. 2019-07-30 12:14:46 -04:00
.enable_practracker_in_hooks pre-push hook: Only run practracker when a special file is present 2019-08-08 11:36:05 -04:00
exceptions.txt Merge branch 'ticket31176' into ticket31176_merged 2019-08-21 09:46:20 -04:00
includes.py Make includes interface more like the rest of practracker 2019-08-05 17:48:06 -04:00
metrics.py Teach practracker about .h files 2019-08-05 10:31:02 -04:00
practracker_tests.py Port practracker unit tests to python 3 2019-08-01 14:00:48 -04:00
practracker.py Document new practracker violation types, and add a practracker readme 2019-08-21 10:17:26 -04:00
problem.py Merge branch 'ticket31176' into ticket31176_merged 2019-08-21 09:46:20 -04:00
README Document new practracker violation types, and add a practracker readme 2019-08-21 10:17:26 -04:00
test_practracker.sh Adjust test_practracker.sh to work on windows 2019-08-01 15:43:54 -04:00
util.py Teach practracker about .h files 2019-08-05 10:31:02 -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".