From 06b9256b11c7aef47b34f37791bfadc4699947b6 Mon Sep 17 00:00:00 2001 From: Yury Bayda Date: Sat, 25 Jul 2026 22:07:07 -0700 Subject: [PATCH] docs: tighten the clang-tidy and make lint prose Comment and prose wording only; no functional change. Names HeaderFilterRegex explicitly in .clang-tidy, and states the make lint failure condition as a sentence rather than a clause. --- .clang-tidy | 4 ++-- README.md | 5 +++-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/.clang-tidy b/.clang-tidy index d83a54e..7b6ae92 100644 --- a/.clang-tidy +++ b/.clang-tidy @@ -2,8 +2,8 @@ FormatStyle: file # Every enabled check gates the build: clang-tidy exits nonzero only on errors, so # anything short of '*' here lets findings print in CI without failing it. WarningsAsErrors: '*' -# clang-tidy sees the absolute paths resolved by the preprocessor, so a project-relative anchor -# matches no headers and drops their diagnostics. '.*' does not add dependency noise: Conan's +# HeaderFilterRegex matches absolute header paths in clang-tidy diagnostics, so a project-relative +# anchor excludes every project header. Matching all paths adds no dependency noise: Conan's # CMakeConfigDeps targets use -isystem, and clang-tidy suppresses system headers by default. HeaderFilterRegex: '.*' diff --git a/README.md b/README.md index 110fc33..d0e8543 100644 --- a/README.md +++ b/README.md @@ -226,8 +226,9 @@ make lint ([prettier](https://prettier.io); `conan.lock` is excluded because Conan owns its formatting). `make lint` runs clang-tidy against the debug compilation database, `cmake-lint` on `CMakeLists.txt`, `ruff check` on `scripts/`, and -[markdownlint](https://github.com/DavidAnson/markdownlint-cli2) on Markdown files; every enabled -check is an error. CI pins all lint and format tool versions in [`.github/ci.env`](.github/ci.env). +[markdownlint](https://github.com/DavidAnson/markdownlint-cli2) on Markdown files. Any reported +finding fails the target. CI pins all lint and format tool versions in +[`.github/ci.env`](.github/ci.env). ## Coverage