torproject/tor
1
0
Fork 0
mirror of https://gitlab.torproject.org/tpo/core/tor.git synced 2024-12-06 19:41:15 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Document new practracker violation types, and add a practracker readme

Browse Source 
Closes ticket 31476.
This commit is contained in:
Nick Mathewson
2019-08-21 10:00:05 -04:00
parent cc48eff2d3
commit 5b3741e05a
3 changed files with 30 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
scripts/maint/practracker/README
+21
View File
@@ -0,0 +1,21 @@
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".
scripts/maint/practracker/practracker.py
+8 -3
View File
@@ -7,7 +7,8 @@ Go through the various .c files and collect metrics about them. If the metrics
violate some of our best practices and they are not found in the optional
exceptions file, then log a problem about them.
We currently do metrics about file size, function size and number of includes.
We currently do metrics about file size, function size and number of includes,
for C files and headers.
practracker.py should be run with its second argument pointing to the Tor
top-level source directory like this:
@@ -143,8 +144,12 @@ HEADER="""\
#
# There are three kinds of problems that we recognize right now:
# function-size -- a function of more than {MAX_FUNCTION_SIZE} lines.
# file-size -- a file of more than {MAX_FILE_SIZE} lines.
# include-count -- a file with more than {MAX_INCLUDE_COUNT} #includes.
# file-size -- a C file of more than {MAX_FILE_SIZE} lines, or an H
# file with more than {MAX_H_FILE_SIZE} lines.
# include-count -- a C file with more than {MAX_INCLUDE_COUNT} #includes,
or an H file with more than {MAX_H_INCLUDE_COUNT} #includes.
# dependency-violation -- a file includes a header that it should
# not, according to an advisory .may_include file.
#
# Each line below represents a single exception that practracker should
# _ignore_. Each line has four parts: