From 893783909ba13ba55fe7a79c419ec1d0ca14555c Mon Sep 17 00:00:00 2001 From: Xianpeng Shen <3353385+shenxianpeng@users.noreply.github.com> Date: Sun, 18 Oct 2026 21:49:51 +0000 Subject: [PATCH] docs: fix changed-files note and LLVM ranges of the clang-tidy and clang-apply-replacements wheels --- docs/getting-started.md | 10 +++++----- docs/overrides/home.html | 4 ++-- docs/why-cpp-linter.md | 2 +- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index cd43001..32565a9 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -80,7 +80,7 @@ repos: ``` Run `pre-commit install` once in each clone. `--version=21` installs the newest 21.x wheel; -clang-tidy wheels cover LLVM 13 to 22. The clang-tidy hook needs a `compile_commands.json`, which +clang-tidy wheels cover LLVM 13 to 23. The clang-tidy hook needs a `compile_commands.json`, which it looks for in `build/` and a few other directories; leave it out if you only run clang-tidy in CI. [Set up a clang-format pre-commit hook](blog/posts/2026-09-20-clang-format-pre-commit-hook.md) walks through the whole setup. @@ -97,9 +97,9 @@ cpp-linter --version=21 --style=file --tidy-checks='' - It does not install the clang tools. Install them first, for example with clang-tools below; without them, `--version=21` falls back to whatever `clang-format` is on your PATH. - It exits 0 even when checks fail, so it reports findings but does not fail a build. -- Locally, `--files-changed-only` and `--lines-changed-only` read `git diff`. In other CI, check - the whole repository (the default): most CI systems set `CI=true`, and with it those options ask - the GitHub API for the changed files. +- Locally and in other CI, `--files-changed-only` and `--lines-changed-only` read `git diff`; + `--diff-base` sets the commit to compare against. Only on GitHub Actions, which sets + `GITHUB_ACTIONS=true`, do they ask the GitHub API for the changed files. cpp-linter v2, a rewrite in Rust ([cpp-linter-rs](https://github.com/cpp-linter/cpp-linter-rs)), is in release candidates. Use the Python package until 2.0 is released. @@ -124,5 +124,5 @@ llvm-symbolizer. The Docker images carry Ubuntu's clang-format and clang-tidy pa Single tools are also on PyPI as Python wheels: `clang-format` and `clang-tidy` (the wheels cpp-linter-hooks installs), [clang-apply-replacements](https://pypi.org/project/clang-apply-replacements/) -(LLVM 16 and 17) and [clang-include-cleaner](https://pypi.org/project/clang-include-cleaner/) +(LLVM 16 to 23) and [clang-include-cleaner](https://pypi.org/project/clang-include-cleaner/) (LLVM 22). diff --git a/docs/overrides/home.html b/docs/overrides/home.html index ed78e9c..a631817 100644 --- a/docs/overrides/home.html +++ b/docs/overrides/home.html @@ -153,7 +153,7 @@

}, { "title": "Before every commit", "name": "cpp-linter-hooks", "icon": "octicons/git-commit-24", - "text": "pre-commit hooks that pip-install the clang-format and clang-tidy version you pin, on every developer's machine. clang-tidy wheels cover LLVM 13 to 22.", + "text": "pre-commit hooks that pip-install the clang-format and clang-tidy version you pin, on every developer's machine. clang-tidy wheels cover LLVM 13 to 23.", "code": "args: [--style=file, --version=21]", "href": "https://github.com/cpp-linter/cpp-linter-hooks", "cta": "View on GitHub", }, @@ -212,7 +212,7 @@

Pin the same LLVM version in each tool

Different clang-format releases can format the same file differently. Set the same LLVM version in the action, the pre-commit hooks and on your machine, and every step runs the same major - release. The clang-tidy hook covers LLVM 13 to 22; the action and + release. The clang-tidy hook covers LLVM 13 to 23; the action and clang-tools cover 12 to 23.

diff --git a/docs/why-cpp-linter.md b/docs/why-cpp-linter.md index 2d7bd8d..91ca152 100644 --- a/docs/why-cpp-linter.md +++ b/docs/why-cpp-linter.md @@ -38,7 +38,7 @@ is no Docker image to build before the first result. The same tools run outside the action too. The pre-commit hooks in [cpp-linter-hooks](https://github.com/cpp-linter/cpp-linter-hooks) take the same version number -(the clang-tidy hook covers LLVM 13 to 22). The [cpp-linter](https://pypi.org/project/cpp-linter/) +(the clang-tidy hook covers LLVM 13 to 23). The [cpp-linter](https://pypi.org/project/cpp-linter/) CLI runs from a script or another CI system; it expects the clang tools to be installed already and exits 0 even when checks fail. On a laptop, `clang-tools` installs the binaries.