[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:56:13 PDT 2024


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

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

>From 1f8eb0e986d6733af726915c1a83433c2cc56fbf Mon Sep 17 00:00:00 2001
From: hill <hill at hilll.dev>
Date: Mon, 7 Oct 2024 17:21:57 +0200
Subject: [PATCH] [clang-tidy] Fix incorrect command-line option in docs

Updated the `HeaderFilterRegex` description to reference `--header-filter` instead of the incorrect `--header-filter-regex` in the clang-tidy documentation.
---
 clang-tools-extra/docs/clang-tidy/index.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

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.



More information about the cfe-commits mailing list