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

[clang-tidy][docs] Add description of "clang-diagnostic-error" (#153870)

Browse Source 
This helps better distinguish warnings that could be disabled via
`.clang-tidy` config (like `clang-diagnostic-literal-conversion`) from
errors that could not be suppressed at all (like
`clang-diagnostic-error`) because it's a hard compiler error.
This commit is contained in:
Baranov Victor 2025-08-18 00:18:32 +03:00 committed by GitHub
parent 7610b13729
commit dff8dac9dc
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -111,6 +111,13 @@ Diagnostics which have a corresponding warning option, are named
``-Wliteral-conversion`` will be reported with check name
``clang-diagnostic-literal-conversion``.
Clang compiler errors (such as syntax errors, semantic errors, or other failures
that prevent Clang from compiling the code) are reported with the check name
``clang-diagnostic-error``. These represent fundamental compilation failures that
must be fixed before :program:`clang-tidy` can perform its analysis. Unlike other
diagnostics, ``clang-diagnostic-error`` cannot be disabled, as :program:`clang-tidy`
requires valid code to function.
The ``-fix`` flag instructs :program:`clang-tidy` to fix found errors if
supported by corresponding checks.