README 765 B

123456789101112131415161718192021
  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. Right now, practracker looks for the following kinds of
  5. best-practices violations:
  6. .c files greater than 3000 lines long
  7. .h files greater than 500 lines long
  8. .c files with more than 50 includes
  9. .h files with more than 15 includes
  10. All files that include a local header not listed in a .may_include
  11. file in the same directory, when that .may_include file has an
  12. "!advisory" marker.
  13. The list of current violations is tracked in exceptions.txt; slight
  14. deviations of the current exceptions cause warnings, whereas large
  15. ones cause practracker to fail.
  16. For usage information, run "practracker.py --help".