mirror of
https://github.com/brain-hackers/u-boot-brain
synced 2024-08-20 00:48:52 +09:00
![Tom Rini](/assets/img/avatar_default.png)
When U-Boot started using SPDX tags we were among the early adopters and there weren't a lot of other examples to borrow from. So we picked the area of the file that usually had a full license text and replaced it with an appropriate SPDX-License-Identifier: entry. Since then, the Linux Kernel has adopted SPDX tags and they place it as the very first line in a file (except where shebangs are used, then it's second line) and with slightly different comment styles than us. In part due to community overlap, in part due to better tag visibility and in part for other minor reasons, switch over to that style. This commit changes all instances where we have a single declared license in the tag as both the before and after are identical in tag contents. There's also a few places where I found we did not have a tag and have introduced one. Signed-off-by: Tom Rini <trini@konsulko.com>
175 lines
6.1 KiB
Python
175 lines
6.1 KiB
Python
# SPDX-License-Identifier: GPL-2.0+
|
|
# Copyright (c) 2011 The Chromium OS Authors.
|
|
#
|
|
|
|
import collections
|
|
import command
|
|
import gitutil
|
|
import os
|
|
import re
|
|
import sys
|
|
import terminal
|
|
|
|
def FindCheckPatch():
|
|
top_level = gitutil.GetTopLevel()
|
|
try_list = [
|
|
os.getcwd(),
|
|
os.path.join(os.getcwd(), '..', '..'),
|
|
os.path.join(top_level, 'tools'),
|
|
os.path.join(top_level, 'scripts'),
|
|
'%s/bin' % os.getenv('HOME'),
|
|
]
|
|
# Look in current dir
|
|
for path in try_list:
|
|
fname = os.path.join(path, 'checkpatch.pl')
|
|
if os.path.isfile(fname):
|
|
return fname
|
|
|
|
# Look upwwards for a Chrome OS tree
|
|
while not os.path.ismount(path):
|
|
fname = os.path.join(path, 'src', 'third_party', 'kernel', 'files',
|
|
'scripts', 'checkpatch.pl')
|
|
if os.path.isfile(fname):
|
|
return fname
|
|
path = os.path.dirname(path)
|
|
|
|
sys.exit('Cannot find checkpatch.pl - please put it in your ' +
|
|
'~/bin directory or use --no-check')
|
|
|
|
def CheckPatch(fname, verbose=False):
|
|
"""Run checkpatch.pl on a file.
|
|
|
|
Returns:
|
|
namedtuple containing:
|
|
ok: False=failure, True=ok
|
|
problems: List of problems, each a dict:
|
|
'type'; error or warning
|
|
'msg': text message
|
|
'file' : filename
|
|
'line': line number
|
|
errors: Number of errors
|
|
warnings: Number of warnings
|
|
checks: Number of checks
|
|
lines: Number of lines
|
|
stdout: Full output of checkpatch
|
|
"""
|
|
fields = ['ok', 'problems', 'errors', 'warnings', 'checks', 'lines',
|
|
'stdout']
|
|
result = collections.namedtuple('CheckPatchResult', fields)
|
|
result.ok = False
|
|
result.errors, result.warning, result.checks = 0, 0, 0
|
|
result.lines = 0
|
|
result.problems = []
|
|
chk = FindCheckPatch()
|
|
item = {}
|
|
result.stdout = command.Output(chk, '--no-tree', fname,
|
|
raise_on_error=False)
|
|
#pipe = subprocess.Popen(cmd, stdout=subprocess.PIPE)
|
|
#stdout, stderr = pipe.communicate()
|
|
|
|
# total: 0 errors, 0 warnings, 159 lines checked
|
|
# or:
|
|
# total: 0 errors, 2 warnings, 7 checks, 473 lines checked
|
|
re_stats = re.compile('total: (\\d+) errors, (\d+) warnings, (\d+)')
|
|
re_stats_full = re.compile('total: (\\d+) errors, (\d+) warnings, (\d+)'
|
|
' checks, (\d+)')
|
|
re_ok = re.compile('.*has no obvious style problems')
|
|
re_bad = re.compile('.*has style problems, please review')
|
|
re_error = re.compile('ERROR: (.*)')
|
|
re_warning = re.compile('WARNING: (.*)')
|
|
re_check = re.compile('CHECK: (.*)')
|
|
re_file = re.compile('#\d+: FILE: ([^:]*):(\d+):')
|
|
|
|
for line in result.stdout.splitlines():
|
|
if verbose:
|
|
print(line)
|
|
|
|
# A blank line indicates the end of a message
|
|
if not line and item:
|
|
result.problems.append(item)
|
|
item = {}
|
|
match = re_stats_full.match(line)
|
|
if not match:
|
|
match = re_stats.match(line)
|
|
if match:
|
|
result.errors = int(match.group(1))
|
|
result.warnings = int(match.group(2))
|
|
if len(match.groups()) == 4:
|
|
result.checks = int(match.group(3))
|
|
result.lines = int(match.group(4))
|
|
else:
|
|
result.lines = int(match.group(3))
|
|
elif re_ok.match(line):
|
|
result.ok = True
|
|
elif re_bad.match(line):
|
|
result.ok = False
|
|
err_match = re_error.match(line)
|
|
warn_match = re_warning.match(line)
|
|
file_match = re_file.match(line)
|
|
check_match = re_check.match(line)
|
|
if err_match:
|
|
item['msg'] = err_match.group(1)
|
|
item['type'] = 'error'
|
|
elif warn_match:
|
|
item['msg'] = warn_match.group(1)
|
|
item['type'] = 'warning'
|
|
elif check_match:
|
|
item['msg'] = check_match.group(1)
|
|
item['type'] = 'check'
|
|
elif file_match:
|
|
item['file'] = file_match.group(1)
|
|
item['line'] = int(file_match.group(2))
|
|
|
|
return result
|
|
|
|
def GetWarningMsg(col, msg_type, fname, line, msg):
|
|
'''Create a message for a given file/line
|
|
|
|
Args:
|
|
msg_type: Message type ('error' or 'warning')
|
|
fname: Filename which reports the problem
|
|
line: Line number where it was noticed
|
|
msg: Message to report
|
|
'''
|
|
if msg_type == 'warning':
|
|
msg_type = col.Color(col.YELLOW, msg_type)
|
|
elif msg_type == 'error':
|
|
msg_type = col.Color(col.RED, msg_type)
|
|
elif msg_type == 'check':
|
|
msg_type = col.Color(col.MAGENTA, msg_type)
|
|
return '%s:%d: %s: %s\n' % (fname, line, msg_type, msg)
|
|
|
|
def CheckPatches(verbose, args):
|
|
'''Run the checkpatch.pl script on each patch'''
|
|
error_count, warning_count, check_count = 0, 0, 0
|
|
col = terminal.Color()
|
|
|
|
for fname in args:
|
|
result = CheckPatch(fname, verbose)
|
|
if not result.ok:
|
|
error_count += result.errors
|
|
warning_count += result.warnings
|
|
check_count += result.checks
|
|
print('%d errors, %d warnings, %d checks for %s:' % (result.errors,
|
|
result.warnings, result.checks, col.Color(col.BLUE, fname)))
|
|
if (len(result.problems) != result.errors + result.warnings +
|
|
result.checks):
|
|
print("Internal error: some problems lost")
|
|
for item in result.problems:
|
|
sys.stderr.write(
|
|
GetWarningMsg(col, item.get('type', '<unknown>'),
|
|
item.get('file', '<unknown>'),
|
|
item.get('line', 0), item.get('msg', 'message')))
|
|
print
|
|
#print(stdout)
|
|
if error_count or warning_count or check_count:
|
|
str = 'checkpatch.pl found %d error(s), %d warning(s), %d checks(s)'
|
|
color = col.GREEN
|
|
if warning_count:
|
|
color = col.YELLOW
|
|
if error_count:
|
|
color = col.RED
|
|
print(col.Color(color, str % (error_count, warning_count, check_count)))
|
|
return False
|
|
return True
|