nihilist/tor
1
0
Fork 0
mirror of https://gitlab.torproject.org/tpo/core/tor.git synced 2024-11-24 20:33:31 +01:00
Code Issues Packages Projects Releases Wiki Activity
fbc18c8989
tor/scripts/maint/practracker
History
Nick Mathewson 08fd551e9f Regenerate practracker exceptions file for 0.4.3 progress.
2019-10-16 09:15:00 -04:00
..
testdata practracker: Integration test for --list-overbroad 2019-09-18 10:28:33 -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 Regenerate practracker exceptions file for 0.4.3 progress. 2019-10-16 09:15:00 -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: add a missing #. 2019-10-16 09:15:00 -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 practracker: Integration test for --list-overbroad 2019-09-18 10:28:33 -04:00
util.py Practracker: do not list problems when told to --list-overbroad. 2019-09-18 10:28:33 -04:00

README 

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".