tor/scripts/maint/practracker
David Goulet ae9042abbf rust: Remove Rust support from tree
Closes #40469

Signed-off-by: David Goulet <dgoulet@torproject.org>
2021-10-06 15:12:04 -04:00
..
testdata practracker: integration tests for --regen and --regen-overbroad 2020-02-03 13:11:58 -05: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 'maint-0.4.4' into maint-0.4.5 2021-02-05 17:40:25 +00:00
includes.py Improve fname_is_c func in pratracker/includes.py 2021-08-29 22:10:44 +02: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 Correct syntax & formatting in test_pratracker.sh 2021-08-22 20:36:36 +02:00
util.py rust: Remove Rust support from tree 2021-10-06 15:12:04 -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".