Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
yuyawk authored and erenon committed Dec 30, 2024
1 parent c02a862 commit db67701
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# bazel_clang_tidy

Run clang-tidy on Bazel C++ targets directly,
Run clang-tidy on Bazel C/C++ targets directly,
without generating a compile commands database,
and take advantage of Bazels powerful cache mechanism.

Expand Down Expand Up @@ -87,7 +87,8 @@ users may tag a target with `no-clang-tidy` or `noclangtidy`.

## Features

- Run clang-tidy on any C++ target
- Run clang-tidy on any C/C++ target
- A file is treated as C if it has the `.c` extension or its target includes the `clang-tidy-is-c-tu` tag; otherwise, it is treated as C++.
- Run clang-tidy without also building the target
- Use Bazel to cache clang-tidy reports: recompute stale reports only

Expand Down

0 comments on commit db67701

Please sign in to comment.