scripts/maint/practracker/README

   1 Practracker is a simple python tool that keeps track of places where
   2 our code is ugly, and tries to warn us about new ones or ones that
   3 get worse.
   4
   5 Right now, practracker looks for the following kinds of
   6 best-practices violations:
   7
   8   .c files greater than 3000 lines long
   9   .h files greater than 500 lines long
  10   .c files with more than 50 includes
  11   .h files with more than 15 includes
  12
  13   All files that include a local header not listed in a .may_include
  14   file in the same directory, when that .may_include file has an
  15   "!advisory" marker.
  16
  17 The list of current violations is tracked in exceptions.txt; slight
  18 deviations of the current exceptions cause warnings, whereas large
  19 ones cause practracker to fail.
  20
  21 For usage information, run "practracker.py --help".