[clang-tidy][run-clang-tidy.py] Add --config-file=<string> option

[SAtacker]

Summary

• Link to the GitHub Issue: https://github.com/llvm/llvm-project/issues/53745

Details:

• Added config_path variable within the python script which makes the required call to the clang-tidy binary with --config-file option.
• If the config_path is None then config will be used.
• No error is raised if both are given but silently chooses config_path over config

Signed-off-by: Shreyas Atre <[e-mail]>

[JonasToth]

clang-tools-extra/clang-tidy/tool/run-clang-tidy.py

237

please ensure that those option exclude each other. right now it could be used with both options which is a contradiction for clang-tidy

[SAtacker]

Squash commits D120385, D120387 into D120331

[SAtacker]

@JonasToth Could you please review it?

clang-tools-extra/clang-tidy/tool/run-clang-tidy.py

237

Do you mean mutual exclusion? From the docs: https://docs.python.org/3/library/argparse.html#mutual-exclusion

[JonasToth]

LGTM, but please adjust the naming nit to a better name.

do you have commit rights? Otherwise someone (e.g. me) could commit on your behalf, of course with a remark that its your contribution :)

(btw. go ahead and ping me again, I am busy with too many things right now :/)

clang-tools-extra/clang-tidy/tool/run-clang-tidy.py

228–229

nit: i think config_group or so would be better to show that its only config-related. This name is too generic i feel.

237

Yes, thanks :)

[SAtacker]

In D120331#3354021, @JonasToth wrote:

LGTM, but please adjust the naming nit to a better name.

Thanks for the review again.
Will rename the group to config_group as you suggested and I feel that too.

do you have commit rights? Otherwise someone (e.g. me) could commit on your behalf, of course with a remark that its your contribution :)

(btw. go ahead and ping me again, I am busy with too many things right now :/)

I don't have the access to land this commit into the llvm-project. Until then I shall trust this wonderful process :)

[SAtacker]

[clang-tidy][run-clang-tidy.py] Rename group to config_group

Signed-off-by: Shreyas Atre <[e-mail]>

[SAtacker]

Gentle ping @alexfh @JonasToth
Thank you.

clang-tools-extra/clang-tidy/tool/run-clang-tidy.py

228–229

Thanks, done.

[SAtacker]

Gentle reminder to commit on my behalf
@JonasToth
@alexfh
@aaron.ballman
@njames93
@LegalizeAdulthood

Thank you

[aaron.ballman]

In D120331#3384889, @SAtacker wrote:

Gentle reminder to commit on my behalf
@JonasToth
@alexfh
@aaron.ballman
@njames93
@LegalizeAdulthood

Thank you

Thanks for the reminder -- I've commit on your behalf in 9e1f4f13984186984ba37513372c1b7e0c4ba4fd, thank you for the patch!

clang-tools-extra/clang-tidy/tool/run-clang-tidy.py

 def make_absolute(f, directory):
   if os.path.isabs(f):
     return f
   return os.path.normpath(os.path.join(directory, f))
 
 
 def get_tidy_invocation(f, clang_tidy_binary, checks, tmpdir, build_path,
                         header_filter, allow_enabling_alpha_checkers,
-                        extra_arg, extra_arg_before, quiet, config,
-                        line_filter, use_color):
+                        extra_arg, extra_arg_before, quiet, config_path,
+                        config, line_filter, use_color):
   """Gets a command line for clang-tidy."""
   start = [clang_tidy_binary]
   if allow_enabling_alpha_checkers:
     start.append('-allow-enabling-analyzer-alpha-checkers')
   if header_filter is not None:
     start.append('-header-filter=' + header_filter)
   if line_filter is not None:
     start.append('-line-filter=' + line_filter)
if tmpdir is not None:
     start.append(name)
   for arg in extra_arg:
       start.append('-extra-arg=%s' % arg)
   for arg in extra_arg_before:
       start.append('-extra-arg-before=%s' % arg)
   start.append('-p=' + build_path)
   if quiet:
       start.append('-quiet')
-  if config:
+  if config_path:
+      start.append('--config-file=' + config_path)
+  elif config:
       start.append('-config=' + config)
   start.append(f)
   return start
 
 
 def merge_replacement_files(tmpdir, mergefile):
   """Merge all replacement files in a directory into a single file"""
   # The fixes suggested by clang-tidy >= 4.0.0 are given under

 def run_tidy(args, tmpdir, build_path, queue, lock, failed_files):
   """Takes filenames out of queue and runs clang-tidy on them."""
   while True:
     name = queue.get()
     invocation = get_tidy_invocation(name, args.clang_tidy_binary, args.checks,
                                      tmpdir, build_path, args.header_filter,
                                      args.allow_enabling_alpha_checkers,
                                      args.extra_arg, args.extra_arg_before,
-                                     args.quiet, args.config, args.line_filter,
-                                     args.use_color)
+                                     args.quiet, args.config_path, args.config,
+                                     args.line_filter, args.use_color)
 
     proc = subprocess.Popen(invocation, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
     output, err = proc.communicate()
     if proc.returncode != 0:
       if proc.returncode < 0:
         msg = "%s: terminated by signal %d\n" % (name, -proc.returncode)
         err += msg.encode('utf-8')
       failed_files.append(name)
parser.add_argument('-clang-tidy-binary', metavar='PATH',
                       default='clang-tidy',
                       help='path to clang-tidy binary')
   parser.add_argument('-clang-apply-replacements-binary', metavar='PATH',
                       default='clang-apply-replacements',
                       help='path to clang-apply-replacements binary')
   parser.add_argument('-checks', default=None,
                       help='checks filter, when not specified, use clang-tidy '
                       'default')
-  parser.add_argument('-config', default=None,
+  config_group = parser.add_mutually_exclusive_group()
+  config_group.add_argument('-config', default=None,
                       help='Specifies a configuration in YAML/JSON format: '
                       '  -config="{Checks: \'*\', '
                       '                       CheckOptions: [{key: x, '
                       '                                       value: y}]}" '
                       'When the value is empty, clang-tidy will '
                       'attempt to find a file named .clang-tidy for '
                       'each source file in its parent directories.')
+  config_group.add_argument('-config-file', default=None,
+                      help='Specify the path of .clang-tidy or custom config '
+                      'file: e.g. -config-file=/some/path/myTidyConfigFile. '
+                      'This option internally works exactly the same way as '
+                      '-config option after reading specified config file. '
+                      'Use either -config-file or -config, not both.')
   parser.add_argument('-header-filter', default=None,
                       help='regular expression matching the names of the '
                       'headers to output diagnostics from. Diagnostics from '
                       'the main file of each translation unit are always '
                       'displayed.')
   parser.add_argument('-line-filter', default=None,
                       help='List of files with line ranges to filter the'
                       'warnings.')
else:
     # Find our database
     build_path = find_compilation_database(db_path)
 
   try:
     invocation = get_tidy_invocation("", args.clang_tidy_binary, args.checks,
                                      None, build_path, args.header_filter,
                                      args.allow_enabling_alpha_checkers,
                                      args.extra_arg, args.extra_arg_before,
-                                     args.quiet, args.config, args.line_filter,
-                                     args.use_color)
+                                     args.quiet, args.config_path, args.config,
+                                     args.line_filter, args.use_color)
     invocation.append('-list-checks')
     invocation.append('-')
     if args.quiet:
       # Even with -quiet we still want to check if we can call clang-tidy.
       with open(os.devnull, 'w') as dev_null:
         subprocess.check_call(invocation, stdout=dev_null)
     else:
       subprocess.check_call(invocation)