Nick Mathewson
5b3741e05a
Document new practracker violation types, and add a practracker readme
|
4 years ago | |
|---|---|---|
| .. | ||
| testdata | 4 years ago | |
| .enable_practracker_in_hooks | 4 years ago | |
| README | 4 years ago | |
| exceptions.txt | 4 years ago | |
| includes.py | 4 years ago | |
| metrics.py | 4 years ago | |
| practracker.py | 4 years ago | |
| practracker_tests.py | 4 years ago | |
| problem.py | 4 years ago | |
| test_practracker.sh | 4 years ago | |
| util.py | 4 years ago | |
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".
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".