Code review

Author: felix642

clang-tools-extra/clang-tidy/ClangTidyOptions.h

@@ -85,7 +85,7 @@ struct ClangTidyOptions {
   /// main files will always be displayed.
   std::optional<std::string> HeaderFilterRegex;
 
-  /// \brief Exclude warnings from headers matching this filter, even if they
+  /// Exclude warnings from headers matching this filter, even if they
   /// match \c HeaderFilterRegex.
   std::optional<std::string> ExcludeHeaderFilterRegex;
 
@@ -112,9 +112,6 @@ struct ClangTidyOptions {
   /// comments in the relevant check.
   std::optional<std::string> User;
 
-  /// \brief Remove command line arguments sent to the compiler matching this.
-  std::optional<std::vector<std::string>> RemovedArgs;
-
   /// Helper structure for storing option value with priority of the value.
   struct ClangTidyValue {
     ClangTidyValue() = default;
@@ -154,6 +151,9 @@ struct ClangTidyOptions {
   /// Add extra compilation arguments to the start of the list.
   std::optional<ArgList> ExtraArgsBefore;
 
+  /// Remove command line arguments sent to the compiler matching this.
+  std::optional<std::vector<std::string>> RemovedArgs;
+
   /// Only used in the FileOptionsProvider and ConfigOptionsProvider. If true
   /// and using a FileOptionsProvider, it will take a configuration file in the
   /// parent directory (if any exists) and apply this config file on top of the

clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp

@@ -78,6 +78,7 @@ Configuration files:
                                  (if any exists) will be taken and the current
                                  config file will be applied on top of the
                                  parent one.
+  RemovedArgs                  - Same as '--removed-arg'.
   SystemHeaders                - Same as '--system-headers'.
   UseColor                     - Same as '--use-color'.
   User                         - Specifies the name or e-mail of the user
@@ -358,12 +359,12 @@ see https://clang.llvm.org/extra/clang-tidy/QueryBasedCustomChecks.html.
 
 static cl::list<std::string> RemovedArgs("removed-arg", desc(R"(
 List of arguments to remove from the command
-                                   line sent to the compiler. Please note that
-                                   removing arguments might change the semantic
-                                   of the analzed code, possibly leading to
-                                   compiler errors, false positives or
-                                   false negatives. This option is applied 
-                                   before --extra-arg and --extra-arg-before)"),
+line sent to the compiler. Please note that
+removing arguments might change the semantic
+of the analzed code, possibly leading to
+compiler errors, false positives or
+false negatives. This option is applied 
+before --extra-arg and --extra-arg-before)"),
                                          cl::cat(ClangTidyCategory));
 
 namespace clang::tidy {

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

@@ -228,6 +228,13 @@ def main():
         default=[],
         help="Additional argument to prepend to the compiler " "command line.",
     )
+    parser.add_argument(
+        "-removed-arg",
+        dest="removed_arg",
+        action="append",
+        default=[],
+        help="Arguments to remove from the compiler command line.",
+    )
     parser.add_argument(
         "-quiet",
         action="store_true",
@@ -378,6 +385,8 @@ def main():
         common_clang_tidy_args.append("-extra-arg=%s" % arg)
     for arg in args.extra_arg_before:
         common_clang_tidy_args.append("-extra-arg-before=%s" % arg)
+    for arg in args.removed_arg:
+        common_clang_tidy_args.append("-removed-arg=%s" % arg)
     for plugin in args.plugins:
         common_clang_tidy_args.append("-load=%s" % plugin)
     if args.warnings_as_errors:

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

@@ -96,6 +96,7 @@ def get_tidy_invocation(
     allow_enabling_alpha_checkers: bool,
     extra_arg: List[str],
     extra_arg_before: List[str],
+    removed_arg: List[str],
     quiet: bool,
     config_file_path: str,
     config: str,
@@ -135,6 +136,8 @@ def get_tidy_invocation(
         start.append(f"-extra-arg={arg}")
     for arg in extra_arg_before:
         start.append(f"-extra-arg-before={arg}")
+    for arg in removed_arg:
+        start.append(f"-removed-arg={arg}")
     start.append(f"-p={build_path}")
     if quiet:
         start.append("-quiet")
@@ -377,6 +380,7 @@ async def run_tidy(
         args.allow_enabling_alpha_checkers,
         args.extra_arg,
         args.extra_arg_before,
+        args.removed_arg,
         args.quiet,
         args.config_file,
         args.config,
@@ -551,6 +555,13 @@ async def main() -> None:
         default=[],
         help="Additional argument to prepend to the compiler command line.",
     )
+    parser.add_argument(
+        "-removed-arg",
+        dest="removed_arg",
+        action="append",
+        default=[],
+        help="Arguments to remove from the compiler command line.",
+    )
     parser.add_argument(
         "-quiet", action="store_true", help="Run clang-tidy in quiet mode."
     )
@@ -638,6 +649,7 @@ async def main() -> None:
             args.allow_enabling_alpha_checkers,
             args.extra_arg,
             args.extra_arg_before,
+            args.removed_arg,
             args.quiet,
             args.config_file,
             args.config,

clang-tools-extra/docs/ReleaseNotes.rst

@@ -167,8 +167,10 @@ Improvements to clang-tidy
   scripts by adding the `-hide-progress` option to suppress progress and
   informational messages.
 
-- Improved :program:`clang-tidy` by adding the option `RemovedArgs` to remove
-  arguments sent to the compiler when invoking Clang-Tidy.
+- Improved :program:`clang-tidy` by adding the `--removed-arg` option to remove
+  arguments sent to the compiler when invoking Clang-Tidy. This option was also
+  added to :program:`run-clang-tidy.py` and :program:`clang-tidy-diff.py` and 
+  can be configured in the config file through the `RemovedArgs` option.
 
 - Deprecated the :program:`clang-tidy` ``zircon`` module. All checks have been
   moved to the ``fuchsia`` module instead. The ``zircon`` module will be removed

clang-tools-extra/docs/clang-tidy/index.rst

@@ -329,13 +329,7 @@ An overview of all the command-line options:
                                    example, to place the correct user name in
                                    TODO() comments in the relevant check.
     WarningsAsErrors             - Same as '--warnings-as-errors'.
-    RemovedArgs                  - List of arguments to remove from the command
-                                   line sent to the compiler. Please note that
-                                   removing arguments might change the semantic
-                                   of the analzed code, possibly leading to
-                                   compiler errors, false positives or
-                                   false negatives. This option is applied 
-                                   before --extra-arg and --extra-arg-before
+    RemovedArgs                  - Same as '--removed-arg'
 
     The effective configuration can be inspected using --dump-config:
 

clang-tools-extra/test/clang-tidy/infrastructure/removed-args.cpp

@@ -1,7 +1,7 @@
 // RUN: not clang-tidy %s -- -fnot-an-option | FileCheck %s -check-prefix=INVALID-A
 // RUN: clang-tidy %s --config="{RemovedArgs: ['-fnot-an-option']}" -- -fnot-an-option
 // RUN: clang-tidy %s --config="{RemovedArgs: ['-fnot-another-option', '-fnot-an-option']}" -- -fnot-an-option -fnot-another-option
-// RUN clang-tidy %s --removed-arg="-fnot-an-option" -- -fnot-an-option -fnot-another-option | FileCheck %s -check-prefix=INVALID-B
+// RUN: not clang-tidy %s --removed-arg="-fnot-an-option" -- -fnot-an-option -fnot-another-option | FileCheck %s -check-prefix=INVALID-B
 
 // INVALID-A: error: unknown argument: '-fnot-an-option' [clang-diagnostic-error]
 // INVALID-B: error: unknown argument: '-fnot-another-option' [clang-diagnostic-error]