[clang-tools-extra] [clang-tidy] Fix incorrect command-line option in docs (PR #111405)

via cfe-commits cfe-commits at lists.llvm.org
Mon Oct 7 09:57:06 PDT 2024


llvmbot wrote:


<!--LLVM PR SUMMARY COMMENT-->

@llvm/pr-subscribers-clang-tidy

Author: hill (float3)

<details>
<summary>Changes</summary>

Updated the `HeaderFilterRegex` description to reference `--header-filter` instead of the incorrect `--header-filter-regex` in the clang-tidy documentation.

---
Full diff: https://github.com/llvm/llvm-project/pull/111405.diff


1 Files Affected:

- (modified) clang-tools-extra/docs/clang-tidy/index.rst (+1-1) 


``````````diff
diff --git a/clang-tools-extra/docs/clang-tidy/index.rst b/clang-tools-extra/docs/clang-tidy/index.rst
index e38141bdb8be1f..a4233d5d8e2694 100644
--- a/clang-tools-extra/docs/clang-tidy/index.rst
+++ b/clang-tools-extra/docs/clang-tidy/index.rst
@@ -287,7 +287,7 @@ An overview of all the command-line options:
     FormatStyle                  - Same as '--format-style'.
     HeaderFileExtensions         - File extensions to consider to determine if a
                                    given diagnostic is located in a header file.
-    HeaderFilterRegex            - Same as '--header-filter-regex'.
+    HeaderFilterRegex            - Same as '--header-filter'.
     ImplementationFileExtensions - File extensions to consider to determine if a
                                    given diagnostic is located in an
                                    implementation file.

``````````

</details>


https://github.com/llvm/llvm-project/pull/111405


More information about the cfe-commits mailing list