Skip to content

Commit d083c25

Browse files
authored
docs: clarify the meaning of the rev tag and tool version specification (#189)
1 parent 49766b0 commit d083c25

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ repos:
5555
```
5656

5757
> [!TIP]
58-
> By default, the latest version of [`clang-format`](https://pypi.org/project/clang-format/#history) and [`clang-tidy`](https://pypi.org/project/clang-tidy/#history) will be installed if not specified. You can specify the version using the `--version` argument in the `args` list as shown below.
58+
> The `rev` tag (e.g. `v1.1.11`) is the **project** version, not the clang tool version. Each release bundles a default version of `clang-format` and `clang-tidy` — check the [release notes](https://github.com/cpp-linter/cpp-linter-hooks/releases) to see which tool version a given `rev` ships with. To pin an exact tool version independently of the project release, use `--version` as shown below.
5959

6060
### Custom Clang Tool Version
6161

@@ -191,7 +191,8 @@ repos:
191191
|----------------------------------|-------------------------------------------|----------------------------------------|
192192
| Supports `clang-format` and `clang-tidy` | ✅ (`clang-format` & `clang-tidy`)| ✅ (`clang-format` only) |
193193
| Custom configuration files | ✅ `.clang-format`, `.clang-tidy` | ✅ `.clang-format` |
194-
| Specify `clang-format` and `clang-tidy` version | ✅ via `--version` | ✅ via `rev` |
194+
| Specify tool version | ✅ via `--version` arg (e.g. `--version=21`) | ✅ via `rev` tag (e.g. `rev: v21.1.8`) |
195+
| `rev` tag meaning | Project version — see release notes for bundled tool version | Equals the clang-format version directly |
195196
| Supports passing format style string | ✅ via `--style` | ❌ |
196197
| Verbose output | ✅ via `--verbose` | ❌ |
197198
| Dry-run mode | ✅ via `--dry-run` | ❌ |

0 commit comments

Comments
 (0)