fixup! fixup! [clang-tidy] New option to remove arguments from the command line

Code review

Author: felix642

clang-tools-extra/clang-tidy/ClangTidy.cpp

@@ -582,23 +582,23 @@ runClangTidy(clang::tidy::ClangTidyContext &Context,
       };
 
   // Remove unwanted arguments passed to the compiler
-  ArgumentsAdjuster CompilationArgsToRemove =
+  ArgumentsAdjuster PerFileArgumentRemover =
       [&Context](const CommandLineArguments &Args, StringRef Filename) {
         ClangTidyOptions Opts = Context.getOptionsForFile(Filename);
         CommandLineArguments AdjustedArgs = Args;
 
         if (Opts.RemovedArgs) {
-          for (StringRef ArgToIgnore : *Opts.RemovedArgs) {
+          for (StringRef ArgToRemove : *Opts.RemovedArgs) {
             AdjustedArgs.erase(std::remove(AdjustedArgs.begin(),
-                                           AdjustedArgs.end(), ArgToIgnore),
+                                           AdjustedArgs.end(), ArgToRemove),
                                AdjustedArgs.end());
           }
         }
 
         return AdjustedArgs;
       };
 
-  Tool.appendArgumentsAdjuster(CompilationArgsToRemove);
+  Tool.appendArgumentsAdjuster(PerFileArgumentRemover);
   Tool.appendArgumentsAdjuster(PerFileExtraArgumentsInserter);
   Tool.appendArgumentsAdjuster(getStripPluginsAdjuster());
   Context.setEnableProfiling(EnableCheckProfile);

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

@@ -227,10 +227,10 @@ template <> struct MappingTraits<ClangTidyOptions> {
                    Options.ExcludeHeaderFilterRegex);
     IO.mapOptional("FormatStyle", Options.FormatStyle);
     IO.mapOptional("User", Options.User);
-    IO.mapOptional("RemovedArgs", Options.RemovedArgs);
     IO.mapOptional("CheckOptions", Options.CheckOptions);
     IO.mapOptional("ExtraArgs", Options.ExtraArgs);
     IO.mapOptional("ExtraArgsBefore", Options.ExtraArgsBefore);
+    IO.mapOptional("RemovedArgs", Options.RemovedArgs);
     IO.mapOptional("InheritParentConfig", Options.InheritParentConfig);
     IO.mapOptional("UseColor", Options.UseColor);
     IO.mapOptional("SystemHeaders", Options.SystemHeaders);
@@ -294,10 +294,10 @@ ClangTidyOptions &ClangTidyOptions::mergeWith(const ClangTidyOptions &Other,
   overrideValue(SystemHeaders, Other.SystemHeaders);
   overrideValue(FormatStyle, Other.FormatStyle);
   overrideValue(User, Other.User);
-  mergeVectors(RemovedArgs, Other.RemovedArgs);
   overrideValue(UseColor, Other.UseColor);
   mergeVectors(ExtraArgs, Other.ExtraArgs);
   mergeVectors(ExtraArgsBefore, Other.ExtraArgsBefore);
+  mergeVectors(RemovedArgs, Other.RemovedArgs);
   // FIXME: how to handle duplicate names check?
   mergeVectors(CustomChecks, Other.CustomChecks);
   for (const auto &KeyValue : Other.CheckOptions) {

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

@@ -112,8 +112,7 @@ struct ClangTidyOptions {
   /// comments in the relevant check.
   std::optional<std::string> User;
 
-  /// \brief Remove command line arguments sent to the compiler matching this
-  /// regex.
+  /// \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.

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

@@ -18,6 +18,7 @@
 #include "../ClangTidy.h"
 #include "../ClangTidyForceLinker.h"
 #include "../GlobList.h"
+#include "../utils/OptionsUtils.h"
 #include "clang/Tooling/CommonOptionsParser.h"
 #include "llvm/ADT/StringSet.h"
 #include "llvm/Support/CommandLine.h"
@@ -355,6 +356,16 @@ see https://clang.llvm.org/extra/clang-tidy/QueryBasedCustomChecks.html.
                                               cl::init(false),
                                               cl::cat(ClangTidyCategory));
 
+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)"),
+                                         cl::cat(ClangTidyCategory));
+
 namespace clang::tidy {
 
 static void printStats(const ClangTidyStats &Stats) {
@@ -421,6 +432,8 @@ createOptionsProvider(llvm::IntrusiveRefCntPtr<vfs::FileSystem> FS) {
     OverrideOptions.FormatStyle = FormatStyle;
   if (UseColor.getNumOccurrences() > 0)
     OverrideOptions.UseColor = UseColor;
+  if (RemovedArgs.getNumOccurrences() > 0)
+    OverrideOptions.RemovedArgs = RemovedArgs;
 
   auto LoadConfig =
       [&](StringRef Configuration,

clang-tools-extra/docs/ReleaseNotes.rst

@@ -168,7 +168,7 @@ Improvements to clang-tidy
   informational messages.
 
 - Improved :program:`clang-tidy` by adding the option `RemovedArgs` to remove
-  arguments sent to the compiler when invoking clang-tidy.
+  arguments sent to the compiler when invoking Clang-Tidy.
 
 - 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

@@ -330,9 +330,12 @@ An overview of all the command-line options:
                                    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 from the command line 
-                                   might lead to false positive or negatives. 
+                                   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
 
     The effective configuration can be inspected using --dump-config:
 
@@ -342,7 +345,6 @@ An overview of all the command-line options:
       WarningsAsErrors:    ''
       HeaderFileExtensions:         ['', 'h','hh','hpp','hxx']
       ImplementationFileExtensions: ['c','cc','cpp','cxx']
-      RemovedArgs: ['-Werror']
       HeaderFilterRegex:   ''
       FormatStyle:         none
       InheritParentConfig: true

clang-tools-extra/test/clang-tidy/infrastructure/invalid-command-line.cpp

@@ -1,4 +1,4 @@
 // RUN: not clang-tidy --invalid-arg 2>&1 | FileCheck %s
 
 // CHECK: error: clang-tidy{{(\.exe)?}}: Unknown command line argument '--invalid-arg'.  Try: '{{.*}}clang-tidy{{(\.exe)?}} --help'
-// CHECK-NEXT: clang-tidy{{(\.exe)?}}: Did you mean '--extra-arg'?
+// CHECK-NEXT: clang-tidy{{(\.exe)?}}: Did you mean '--removed-arg'?

clang-tools-extra/test/clang-tidy/infrastructure/compilation-args-to-ignore.cpp renamed to clang-tools-extra/test/clang-tidy/infrastructure/removed-args.cpp

@@ -1,5 +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
 
-// INVALID-A: error: unknown argument: '-fnot-an-option' [clang-diagnostic-error]
+// INVALID-A: error: unknown argument: '-fnot-an-option' [clang-diagnostic-error]
+// INVALID-B: error: unknown argument: '-fnot-another-option' [clang-diagnostic-error]