nihilist/tor
1
0
Fork 0
mirror of https://gitlab.torproject.org/tpo/core/tor.git synced 2024-12-11 05:03:34 +01:00
Code Issues Packages Projects Releases Wiki Activity
714e235a3c
tor/scripts/maint/practracker
History
Nick Mathewson fc16dbf7aa Remove "enable_practracker_in_hooks" for 0.4.4.
2020-06-09 15:47:25 -04:00
..
testdata practracker: integration tests for --regen and --regen-overbroad 2020-02-03 13:11:58 -05:00
exceptions.txt config: New file resolve_addr.{c|h} 2020-05-05 14:24:04 -04:00
includes.py Try rewriting normalize_srcdir to normalize harder. 2020-04-07 17:36:05 +10:00
metrics.py Stop assuming that /usr/bin/python exists 2020-02-16 21:58:01 +02:00
practracker_tests.py Stop assuming that /usr/bin/python exists 2020-02-16 21:58:01 +02:00
practracker.py Merge branch 'maint-0.4.3' 2020-02-20 10:44:43 -05:00
problem.py practracker: add a --regen-overbroad option to remove overbroad exceptions. 2020-02-03 13:02:12 -05:00
README practracker: make filename terminology uniform 2019-08-29 09:20:27 -04:00
test_practracker.sh practracker: integration tests for --regen and --regen-overbroad 2020-02-03 13:11:58 -05:00
util.py python: Add __future__ imports for python 3 compatibility 2019-12-12 15:58:51 +10: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".