nihilist/tor
1
0
Fork 0
mirror of https://gitlab.torproject.org/tpo/core/tor.git synced 2024-11-12 22:23:49 +01:00
Code Issues Packages Projects Releases Wiki Activity

practracker: make filename terminology uniform

Browse Source 
Previously we often referred to "C files" and "H files", which is
more ambiguous than ".c files" and ".h files".
This commit is contained in:
Nick Mathewson 2019-08-29 09:20:27 -04:00
parent 5b3741e05a
commit e3f7e5e65e
3 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
scripts/maint/practracker/README
View File

@ -5,10 +5,10 @@ get worse.
Right now, practracker looks for the following kinds of Right now, practracker looks for the following kinds of
best-practices violations: best-practices violations:
C files greater than 3000 lines long .c files greater than 3000 lines long
H files greater than 500 lines long .h files greater than 500 lines long
C files with more than 50 includes .c files with more than 50 includes
H files with more than 15 includes .h files with more than 15 includes
All files that include a local header not listed in a .may_include 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 file in the same directory, when that .may_include file has an

2
scripts/maint/practracker/includes.py
View File

@ -212,7 +212,7 @@ def consider_include_rules(fname, f):
log_sorted_levels = False log_sorted_levels = False
def walk_c_files(topdir="src"): def walk_c_files(topdir="src"):
"""Run through all c and h files under topdir, looking for """Run through all .c and .h files under topdir, looking for
include-rule violations. Yield those violations.""" include-rule violations. Yield those violations."""
for dirpath, dirnames, fnames in os.walk(topdir): for dirpath, dirnames, fnames in os.walk(topdir):

16
scripts/maint/practracker/practracker.py
View File

@ -8,7 +8,7 @@ violate some of our best practices and they are not found in the optional
exceptions file, then log a problem about them. 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. for C source files and headers.
practracker.py should be run with its second argument pointing to the Tor practracker.py should be run with its second argument pointing to the Tor
top-level source directory like this: top-level source directory like this:
@ -144,10 +144,10 @@ HEADER="""\
# #
# There are three kinds of problems that we recognize right now: # There are three kinds of problems that we recognize right now:
# function-size -- a function of more than {MAX_FUNCTION_SIZE} lines. # function-size -- a function of more than {MAX_FUNCTION_SIZE} lines.
# file-size -- a C file of more than {MAX_FILE_SIZE} lines, or an H # file-size -- a .c file of more than {MAX_FILE_SIZE} lines, or a .h
# file with more than {MAX_H_FILE_SIZE} lines. # file with more than {MAX_H_FILE_SIZE} lines.
# include-count -- a C file with more than {MAX_INCLUDE_COUNT} #includes, # include-count -- a .c file with more than {MAX_INCLUDE_COUNT} #includes,
or an H file with more than {MAX_H_INCLUDE_COUNT} #includes. or a .h file with more than {MAX_H_INCLUDE_COUNT} #includes.
# dependency-violation -- a file includes a header that it should # dependency-violation -- a file includes a header that it should
# not, according to an advisory .may_include file. # not, according to an advisory .may_include file.
# #
@ -189,13 +189,13 @@ def main(argv):
parser.add_argument("--terse", action="store_true", parser.add_argument("--terse", action="store_true",
help="Do not emit helpful instructions.") help="Do not emit helpful instructions.")
parser.add_argument("--max-h-file-size", default=MAX_H_FILE_SIZE, parser.add_argument("--max-h-file-size", default=MAX_H_FILE_SIZE,
help="Maximum lines per .H file") help="Maximum lines per .h file")
parser.add_argument("--max-h-include-count", default=MAX_H_INCLUDE_COUNT, parser.add_argument("--max-h-include-count", default=MAX_H_INCLUDE_COUNT,
help="Maximum includes per .H file") help="Maximum includes per .h file")
parser.add_argument("--max-file-size", default=MAX_FILE_SIZE, parser.add_argument("--max-file-size", default=MAX_FILE_SIZE,
help="Maximum lines per C file") help="Maximum lines per .c file")
parser.add_argument("--max-include-count", default=MAX_INCLUDE_COUNT, parser.add_argument("--max-include-count", default=MAX_INCLUDE_COUNT,
help="Maximum includes per C file") help="Maximum includes per .c file")
parser.add_argument("--max-function-size", default=MAX_FUNCTION_SIZE, parser.add_argument("--max-function-size", default=MAX_FUNCTION_SIZE,
help="Maximum lines per function") help="Maximum lines per function")
parser.add_argument("--max-dependency-violations", default=MAX_DEP_VIOLATIONS, parser.add_argument("--max-dependency-violations", default=MAX_DEP_VIOLATIONS,