yuzu-emu/mbedtls
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Merge remote-tracking branch 'origin/pr/2730' into development

Browse source 
* origin/pr/2730:
  Allow TODO in code
  Use the docstring in the command line help
This commit is contained in:
Jaeden Amero 2019-07-09 13:56:58 +01:00
commit 5db519b59a
1 changed files with 6 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
tests/scripts/check-files.py
View file

@ -1,14 +1,12 @@
#!/usr/bin/env python3 #!/usr/bin/env python3
# This file is part of Mbed TLS (https://tls.mbed.org)
# Copyright (c) 2018, Arm Limited, All Rights Reserved
""" """
This file is part of Mbed TLS (https://tls.mbed.org)
Copyright (c) 2018, Arm Limited, All Rights Reserved
Purpose
This script checks the current state of the source code for minor issues, This script checks the current state of the source code for minor issues,
including incorrect file permissions, presence of tabs, non-Unix line endings, including incorrect file permissions, presence of tabs, non-Unix line endings,
trailing whitespace, presence of UTF-8 BOM, and TODO comments. trailing whitespace, and presence of UTF-8 BOM.
Note: requires python 3, must be run from Mbed TLS root. Note: requires python 3, must be run from Mbed TLS root.
""" """
@ -170,19 +168,6 @@ class MergeArtifactIssueTracker(LineIssueTracker):
return True return True
return False return False
class TodoIssueTracker(LineIssueTracker):
"""Track lines containing ``TODO``."""
heading = "TODO present:"
files_exemptions = frozenset([
os.path.basename(__file__),
"benchmark.c",
"pull_request_template.md",
])
def issue_with_line(self, line, _filepath):
return b"todo" in line.lower()
class IntegrityChecker(object): class IntegrityChecker(object):
"""Sanity-check files under the current directory.""" """Sanity-check files under the current directory."""
@ -211,7 +196,6 @@ class IntegrityChecker(object):
TrailingWhitespaceIssueTracker(), TrailingWhitespaceIssueTracker(),
TabIssueTracker(), TabIssueTracker(),
MergeArtifactIssueTracker(), MergeArtifactIssueTracker(),
TodoIssueTracker(),
] ]
@staticmethod @staticmethod
@ -257,15 +241,7 @@ class IntegrityChecker(object):
def run_main(): def run_main():
parser = argparse.ArgumentParser( parser = argparse.ArgumentParser(description=__doc__)
description=(
"This script checks the current state of the source code for "
"minor issues, including incorrect file permissions, "
"presence of tabs, non-Unix line endings, trailing whitespace, "
"presence of UTF-8 BOM, and TODO comments. "
"Note: requires python 3, must be run from Mbed TLS root."
)
)
parser.add_argument( parser.add_argument(
"-l", "--log_file", type=str, help="path to optional output log", "-l", "--log_file", type=str, help="path to optional output log",
) )