Skip to content

docs: explain version requirements and where clang tools come from (v3) - #531

Merged
2bndy5 merged 1 commit into
v3.0.0-rc0from
claude/project-thread-zummh0
Nov 13, 2026
Merged

2bndy5 merged 1 commit into
v3.0.0-rc0from
claude/project-thread-zummh0

Conversation

@shenxianpeng

@shenxianpeng shenxianpeng commented Nov 13, 2026 •

Copy link
Copy Markdown
Member

Docs only, for the v3 branch (#283).

  • version input: it still pointed at clang-tools-pip and only listed major versions. In v3 it is a semantic version requirement, so the description now says that 18.1.8 accepts 18.1.8 or a newer 18.x release, =18.1.8 requires exactly that version, and ranges like >=17, <20 work. A user on Moving toward v3 #283 / Allow to specify minor/patch version for clang-format #292 set 18.1.8 and was surprised by what got installed.
  • docs/required-tools.md: the per-OS source lists described v2 (static binaries before PyPI, no package manager on Windows). Replaced them with the order cpp-linter v2 uses on every runner: installed tool, cache, system package manager (apt with LLVM's apt repository, dnf, pacman, Homebrew / Homebrew / Chocolatey, winget), PyPI, static binaries. The link now points to clang-tools-static-binaries.
  • cspell: added pacman and winget.

The `version` input still pointed at clang-tools-pip and only listed
major versions. v3 passes it to cpp-linter v2 as a semantic version
requirement, so `18.1.8` means 18.1.8 or a newer 18.x release and
`=18.1.8` means exactly that version.

Also list the sources v3 tries, in order, for every runner (installed
tool, cache, system package manager, PyPI, static binaries).
@shenxianpeng
shenxianpeng requested a review from a team as a code owner November 13, 2026 14:23
@shenxianpeng
shenxianpeng requested review from 2bndy5 and removed request for a team November 13, 2026 14:23
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Nov 13, 2026
@shenxianpeng shenxianpeng self-assigned this Nov 13, 2026
@2bndy5
2bndy5 merged commit 9c36637 into v3.0.0-rc0 Nov 13, 2026
4 checks passed
@2bndy5
2bndy5 deleted the claude/project-thread-zummh0 branch November 13, 2026 18:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants