tor/scripts/maint/practracker
Nick Mathewson d1ffac3f8a practracker: An exception is "used" even when it is violated.
The purpose of tracking whether an exception is used is so that we
can tell whether it is overbroad.  This means that an _underbroad_
exception is still a used one.  Fixes bug 31338.
2019-09-18 10:28:33 -04:00
..
testdata Add integration tests for new practracker features 2019-08-26 12:28: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 'tor-github/pr/1264' 2019-09-09 14:53:12 -04: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: do not list problems when told to --list-overbroad. 2019-09-18 10:28:33 -04: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 Merge branch 'ticket31578' into ticket31578_merged 2019-09-11 08:59:29 -04: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".