On Thu, Jul 4, 2024 at 6:28 PM Théo Lebrun <theo.lebrun@xxxxxxxxxxx> wrote: > > Add file filtering feature. We take zero or more filters at the end as > positional arguments. If none are given, the default behavior is kept > and we run the tool on all files in the datastore. Else, files must > match one or more filter to be analysed. > > The below command runs clang-tidy on drivers/clk/clk.c and all C files > inside drivers/reset/. > > ./scripts/clang-tools/run-clang-tools.py clang-tidy \ > compile_commands.json \ > 'drivers/clk/clk.c' 'drivers/reset/*' > > The Python fnmatch builtin module is used. Matching is case-insensitive. > See its documentation for allowed syntax: > https://docs.python.org/3/library/fnmatch.html > > Signed-off-by: Théo Lebrun <theo.lebrun@xxxxxxxxxxx> > --- > Currently, all files in the datastore are analysed. This is not > practical for grabbing errors in a subsystem, or relative to a patch > series. Add a file filtering feature with wildcard support. > > Have a nice day, > Théo > --- > scripts/clang-tools/run-clang-tools.py | 20 ++++++++++++++++++++ > 1 file changed, 20 insertions(+) > > diff --git a/scripts/clang-tools/run-clang-tools.py b/scripts/clang-tools/run-clang-tools.py > index f31ffd09e1ea..b0b3a9c8cdec 100755 > --- a/scripts/clang-tools/run-clang-tools.py > +++ b/scripts/clang-tools/run-clang-tools.py > @@ -10,6 +10,7 @@ compile_commands.json. > """ > > import argparse > +import fnmatch > import json > import multiprocessing > import subprocess > @@ -32,6 +33,8 @@ def parse_arguments(): > help=type_help) > path_help = "Path to the compilation database to parse" > parser.add_argument("path", type=str, help=path_help) > + file_filter_help = "Optional Unix shell-style wildcard file filters" > + parser.add_argument("file_filter", type=str, nargs="*", help=file_filter_help) > > checks_help = "Checks to pass to the analysis" > parser.add_argument("-checks", type=str, default=None, help=checks_help) > @@ -48,6 +51,22 @@ def init(l, a): > args = a > > > +def filter_entries(datastore, filters): > + for entry in datastore: > + if filters == []: > + yield entry > + continue Maybe, this can be checked on the caller side. (Note, I did not test this at all) if args.file_filter: datastore = filter_entries(datastore, args.file_filter) > + > + assert entry['file'].startswith(entry['directory']) > + # filepath is relative to the directory, to avoid matching on the absolute path Does this assertion work with the separate output directory (O= option)? Just try this command: $ make LLVM=1 O=/tmp/foo clang-tidy Check the generated /tmp/foo/compile_commands.json The 'file' entry starts with your source directory. The 'directory' entry starts with the build directory, "/tmp/foo". > + filepath = entry['file'][len(entry['directory']):].lstrip('/') > + > + for pattern in filters: > + if fnmatch.fnmatch(filepath, pattern): > + yield entry > + break > + > + > def run_analysis(entry): > # Disable all checks, then re-enable the ones we want > global args > @@ -87,6 +106,7 @@ def main(): > # Read JSON data into the datastore variable > with open(args.path, "r") as f: > datastore = json.load(f) > + datastore = filter_entries(datastore, args.file_filter) > pool.map(run_analysis, datastore) > except BrokenPipeError: > # Python flushes standard streams on exit; redirect remaining output > > --- > base-commit: 22a40d14b572deb80c0648557f4bd502d7e83826 > change-id: 20240704-clang-tidy-filter-f470377cb2b4 > > Best regards, > -- > Théo Lebrun <theo.lebrun@xxxxxxxxxxx> > > -- Best Regards Masahiro Yamada
