From dff8dac9dca2b1bca3814e6240c41d9cbda42b71 Mon Sep 17 00:00:00 2001 From: Baranov Victor Date: Mon, 18 Aug 2025 00:18:32 +0300 Subject: [PATCH] [clang-tidy][docs] Add description of "clang-diagnostic-error" (#153870) 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. --- clang-tools-extra/docs/clang-tidy/index.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/clang-tools-extra/docs/clang-tidy/index.rst b/clang-tools-extra/docs/clang-tidy/index.rst index e8ce903fcb07..e0cf5ef720b0 100644 --- a/clang-tools-extra/docs/clang-tidy/index.rst +++ b/clang-tools-extra/docs/clang-tidy/index.rst @@ -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.