Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.
Expand All @@ -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).
4 changes: 2 additions & 2 deletions docs/overrides/home.html
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ <h1 class="cl-hero__title">
},
{
"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",
},
Expand Down Expand Up @@ -212,7 +212,7 @@ <h2 class="cl-h2">Pin the same LLVM version in each tool</h2>
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.
</p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/why-cpp-linter.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Loading