alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

tools: check for incorrect case used in Kconfig filenames

Browse Source
This commit is contained in:
Roland Dobai 2019-01-31 13:41:31 +01:00
parent d1dd3ab0d3
commit bcd584a63f
1 changed files with 44 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
tools/check_kconfigs.py
View File

@ -22,8 +22,8 @@ import re
import argparse import argparse
from io import open from io import open
# regular expression search object for matching Kconfig files # regular expression for matching Kconfig files
RE_KCONFIG = re.compile(r'^Kconfig(?:\.projbuild)?$') RE_KCONFIG = r'^Kconfig(?:\.projbuild)?$'
# ouput file with suggestions will get this suffix # ouput file with suggestions will get this suffix
OUTPUT_SUFFIX = '.new' OUTPUT_SUFFIX = '.new'
@ -358,9 +358,10 @@ def main():
check_ignore_dirs = default_path is not None and os.path.abspath(args.directory) == os.path.abspath(default_path) check_ignore_dirs = default_path is not None and os.path.abspath(args.directory) == os.path.abspath(default_path)
for root, dirnames, filenames in os.walk(args.directory): for root, dirnames, filenames in os.walk(args.directory):
for filename in [f for f in filenames if RE_KCONFIG.search(f)]: for filename in filenames:
full_path = os.path.join(root, filename) full_path = os.path.join(root, filename)
path_in_idf = os.path.relpath(full_path, args.directory) path_in_idf = os.path.relpath(full_path, args.directory)
if re.search(RE_KCONFIG, filename):
if check_ignore_dirs and path_in_idf.startswith(IGNORE_DIRS): if check_ignore_dirs and path_in_idf.startswith(IGNORE_DIRS):
print('{}: Ignored'.format(path_in_idf)) print('{}: Ignored'.format(path_in_idf))
ignore_counter += 1 ignore_counter += 1
@ -385,9 +386,9 @@ def main():
raise ValueError("The encoding of {} is not Unicode.".format(path_in_idf)) raise ValueError("The encoding of {} is not Unicode.".format(path_in_idf))
if failure: if failure:
print('{} has been saved with suggestions for resolving the issues. Please note that the suggestions ' print('{} has been saved with suggestions for resolving the issues. Please note that the '
'can be wrong and you might need to re-run the checker several times for solving all issues.' 'suggestions can be wrong and you might need to re-run the checker several times '
''.format(path_in_idf + OUTPUT_SUFFIX)) 'for solving all issues'.format(path_in_idf + OUTPUT_SUFFIX))
print('Please fix the errors and run {} for checking the correctness of ' print('Please fix the errors and run {} for checking the correctness of '
'Kconfigs.'.format(os.path.relpath(os.path.abspath(__file__), args.directory))) 'Kconfigs.'.format(os.path.relpath(os.path.abspath(__file__), args.directory)))
sys.exit(1) sys.exit(1)
@ -399,6 +400,9 @@ def main():
except Exception: except Exception:
# not a serious error is when the file cannot be deleted # not a serious error is when the file cannot be deleted
print('{} cannot be deleted!'.format(suggestions_full_path)) print('{} cannot be deleted!'.format(suggestions_full_path))
elif re.search(RE_KCONFIG, filename, re.IGNORECASE):
# On Windows Kconfig files are working with different cases!
raise ValueError('Incorrect filename of {}. The case should be "Kconfig"!'.format(path_in_idf))
if ignore_counter > 0: if ignore_counter > 0:
print('{} files have been ignored.'.format(ignore_counter)) print('{} files have been ignored.'.format(ignore_counter))