[readability-duplicate-include] Rename options, update docs, and format code

Author: lakshsidhu04

clang-tools-extra/clang-tidy/readability/DuplicateIncludeCheck.cpp

@@ -66,8 +66,7 @@ class DuplicateIncludeCallbacks : public PPCallbacks {
   const SourceManager &SM;
   std::vector<llvm::Regex> AllowedDuplicateRegex;
 
-  bool IsAllowedDuplicateInclude(StringRef TokenName, OptionalFileEntryRef File,
-                                 StringRef RelativePath);
+  bool IsAllowedDuplicateInclude(StringRef TokenName);
 };
 
 } // namespace
@@ -105,7 +104,7 @@ void DuplicateIncludeCallbacks::InclusionDirective(
     return;
 
   // if duplicate allowed, record and return
-  if (IsAllowedDuplicateInclude(FileName, File, RelativePath)) {
+  if (IsAllowedDuplicateInclude(FileName)) {
     Files.back().push_back(FileName);
     return;
   }
@@ -134,37 +133,24 @@ void DuplicateIncludeCallbacks::MacroUndefined(const Token &MacroNameTok,
   Files.back().clear();
 }
 
-bool DuplicateIncludeCallbacks::IsAllowedDuplicateInclude(
-    StringRef TokenName, OptionalFileEntryRef File, StringRef RelativePath) {
-  SmallVector<StringRef, 3> matchArguments;
-  matchArguments.push_back(TokenName);
-
-  if (!RelativePath.empty())
-    matchArguments.push_back(llvm::sys::path::filename(RelativePath));
-
-  if (File) {
-    StringRef RealPath = File->getFileEntry().tryGetRealPathName();
-    if (!RealPath.empty())
-      matchArguments.push_back(llvm::sys::path::filename(RealPath));
-  }
-
+bool DuplicateIncludeCallbacks::IsAllowedDuplicateInclude(StringRef FileName) {
   // try to match with each regex
   for (const llvm::Regex &reg : AllowedDuplicateRegex) {
-    for (StringRef arg : matchArguments) {
-      if (reg.match(arg))
-        return true;
-    }
+    if (reg.match(FileName))
+      return true;
   }
   return false;
 }
+} // namespace clang::tidy::readability
 
+namespace clang::tidy::readability {
 DuplicateIncludeCheck::DuplicateIncludeCheck(StringRef Name,
                                              ClangTidyContext *Context)
     : ClangTidyCheck(Name, Context) {
-  std::string Raw = Options.get("AllowedDuplicateIncludes", "").str();
+  std::string Raw = Options.get("IgnoreHeaders", "").str();
   if (!Raw.empty()) {
     SmallVector<StringRef, 4> StringParts;
-    StringRef(Raw).split(StringParts, ',', -1, false);
+    StringRef(Raw).split(StringParts, ';', -1, false);
 
     for (StringRef Part : StringParts) {
       Part = Part.trim();
@@ -181,7 +167,7 @@ void DuplicateIncludeCheck::registerPPCallbacks(
 }
 
 void DuplicateIncludeCheck::storeOptions(ClangTidyOptions::OptionMap &Opts) {
-  Options.store(Opts, "AllowedDuplicateIncludes",
-                llvm::join(AllowedDuplicateIncludes, ","));
+  Options.store(Opts, "IgnoreHeaders",
+                llvm::join(AllowedDuplicateIncludes, ";"));
 }
 } // namespace clang::tidy::readability

clang-tools-extra/docs/clang-tidy/checks/misc/include-cleaner.rst

@@ -28,7 +28,7 @@ Options
 -------
 
 .. option:: IgnoreHeaders
-
+   
    A semicolon-separated list of regexes to disable insertion/removal of header
    files that match this regex as a suffix.  E.g., `foo/.*` disables
    insertion/removal for all headers under the directory `foo`. Default is an

clang-tools-extra/docs/clang-tidy/checks/readability/duplicate-include.rst

@@ -34,20 +34,12 @@ Because of the intervening macro definitions, this code remains unchanged:
   #include "assertion.h"
   // ...code with assertions disabled
 
-Option: ``AllowedDuplicateIncludes``
-------------------------------------
-
-Headers listed in this option are exempt from warnings. For example:
-
-.. code-block:: c++
-
-  -config='{CheckOptions: [{key: readability-duplicate-include.AllowedDuplicateIncludes, value: "pack_begin.h,pack_end.h"}]}'
-
-This allows regex matches with ``pack_begin.h`` and ``pack_end.h`` to be included multiple times
-without triggering diagnostics.
-
-Notes
------
-
-- Only direct includes in the current translation unit are checked.
-- Useful for removing redundant includes and improving compile times in large codebases.
+Options
+-------
+
+.. option:: IgnoreHeaders
+   
+   A semicolon-separated list of regexes to allow duplicate inclusion of header
+   files that match this regex.  E.g., `foo/.*` disables
+   insertion/removal for all headers under the directory `foo`. Default is an
+   empty string, no headers will be ignored.

clang-tools-extra/docs/clang-tidy/checks/readability/else-after-return.rst

@@ -63,7 +63,6 @@ Options
 -------
 
 .. option:: WarnOnUnfixable
-
    When `true`, emit a warning for cases where the check can't output a
    Fix-It. These can occur with declarations inside the ``else`` branch that
    would have an extended lifetime if the ``else`` branch was removed.

clang-tools-extra/test/clang-tidy/checkers/readability/Inputs/duplicate-include-allowed/other.h

@@ -1,2 +1,2 @@
 // dummy other.h (should warn on duplicate includes)
-#pragma once
+#pragma once

clang-tools-extra/test/clang-tidy/checkers/readability/duplicate-include-allowed.cpp

@@ -1,6 +1,6 @@
 // RUN: %check_clang_tidy %s readability-duplicate-include %t -- \
 // RUN:   -header-filter='' \
-// RUN:   -config='{CheckOptions: [{key: readability-duplicate-include.AllowedDuplicateIncludes, value: "pack_begin.h,pack_end.h"}]}' \
+// RUN:   -config='{CheckOptions: [{key: readability-duplicate-include.IgnoreHeaders, value: "pack_begin.h;pack_end.h"}]}' \
 // RUN:   -- -I %S/Inputs/duplicate-include-allowed
 //
 // This test lives in test/clang-tidy/checkers/