shylie/llvm-project
1
0
Fork 0
Code Issues Pull Requests Actions 6 Packages Projects Releases Wiki Activity

[clang-tidy][docs] Update documentation to current --help (#180575)

Browse Source 
I noticed the documentation is missing this doc fix:
455105f1c6

I reran `clang-tidy --help` on current main.
This commit is contained in:
Florian Scheibner 2026-02-11 03:52:35 +01:00 committed by GitHub
parent ac85248f11
commit 7b56bc85ca
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 22 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
clang-tools-extra/docs/clang-tidy/index.rst
View File

@ -139,6 +139,9 @@ An overview of all the command-line options:
clang-tidy options:
--allow-no-checks - Allow empty enabled checks. This suppresses
the "no checks enabled" error when disabling
all of the checks.
--checks=<string> - Comma-separated list of globs with optional '-'
prefix. Globs are processed in order of
appearance in the list. Globs without '-'
@ -182,6 +185,9 @@ An overview of all the command-line options:
Can be used together with -line-filter.
This option overrides the 'ExcludeHeaderFilterRegex'
option in .clang-tidy file, if any.
--experimental-custom-checks - Enable experimental clang-query based
custom checks.
see https://clang.llvm.org/extra/clang-tidy/QueryBasedCustomChecks.html.
--explain-config - For each enabled check explains, where it is
enabled, i.e. in clang-tidy binary, command
line or a specific configuration file.
@ -244,6 +250,13 @@ An overview of all the command-line options:
printing statistics about ignored warnings and
warnings treated as errors if the respective
options are specified.
--removed-arg=<string> - List of arguments to remove from the command
line sent to the compiler. Please note that
removing arguments might change the semantic
of the analyzed code, possibly leading to
compiler errors, false positives or
false negatives. This option is applied
before --extra-arg and --extra-arg-before
--store-check-profile=<prefix> - By default reports are printed in tabulated
format to stderr. When this option is passed,
these per-TU profiles are instead stored as JSON.
@ -256,7 +269,7 @@ An overview of all the command-line options:
This option overrides the 'UseColor' option in
.clang-tidy file, if any.
--verify-config - Check the config files to ensure each check and
option is recognized.
option is recognized without running any checks.
--vfsoverlay=<filename> - Overlay the virtual filesystem described by file
over the real file system.
--warnings-as-errors=<string> - Upgrades warnings to errors. Same format as
@ -264,9 +277,6 @@ An overview of all the command-line options:
This option's value is appended to the value of
the 'WarningsAsErrors' option in .clang-tidy
file, if any.
--allow-no-checks - Allow empty enabled checks. This suppresses
the "no checks enabled" error when disabling
all of the checks.
-p <build-path> is used to read a compile command database.
@ -307,7 +317,7 @@ An overview of all the command-line options:
Checks - Same as '--checks'. Additionally, the list of
globs can be specified as a list instead of a
string.
CustomChecks - List of user defined checks based on
CustomChecks - Array of user defined checks based on
Clang-Query syntax.
ExcludeHeaderFilterRegex - Same as '--exclude-header-filter'.
ExtraArgs - Same as '--extra-arg'.
@ -324,6 +334,7 @@ An overview of all the command-line options:
(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
@ -331,20 +342,19 @@ 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 - Same as '--removed-arg'
The effective configuration can be inspected using --dump-config:
$ clang-tidy --dump-config
---
Checks: '-*,some-check'
WarningsAsErrors: ''
Checks: '-*,some-check'
WarningsAsErrors: ''
HeaderFileExtensions: ['', 'h','hh','hpp','hxx']
ImplementationFileExtensions: ['c','cc','cpp','cxx']
HeaderFilterRegex: '.*'
FormatStyle: none
InheritParentConfig: true
User: user
HeaderFilterRegex: '.*'
FormatStyle: none
InheritParentConfig: true
User: user
CheckOptions:
some-check.SomeOption: 'some value'
...