highperfocused/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2026-05-29 23:33:33 +02:00
Code Issues Packages Projects Releases Wiki Activity

doc: clarify clang-tidy in developer notes

Browse Source 
Recently, I ran clang-tidy in my system and had to figure out setting it up
correcty on my system (macOS) & understanding its output while tweaking
few arguments that made the output easier to parse.

This patch documents those in the developer notes.
This commit is contained in:
rkrux
2026-04-24 17:29:12 +05:30
parent 3f09a4703f
commit a1e534bbf0
1 changed files with 9 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
doc/developer-notes.md
View File

@@ -164,7 +164,7 @@ To run clang-tidy on Ubuntu/Debian, install the dependencies:
apt install clang-tidy clang
```
Configure with clang as the compiler:
Configure with clang as the compiler with the below command that should create a `compile_commands.json` file within the build directory:
```sh
cmake -B build -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++ -DCMAKE_EXPORT_COMPILE_COMMANDS=ON
@@ -172,12 +172,19 @@ cmake -B build -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++ -DCMAKE_EXP
The output is denoised of errors from external dependencies.
To run clang-tidy on all source files:
To run clang-tidy on all source files using the checks mentioned in the `./src/.clang-tidy` file:
```sh
( cd ./src/ && run-clang-tidy -p ../build -j $(nproc) )
```
To run clang-tidy on one file:
```sh
( cd ./src/ && run-clang-tidy -p ../build -j $(nproc) ./path/to/single_file.cpp )
```
Optionally, append the `run-clang-tidy` command with the `-quiet` option to suppress printing of statistics and ignored warnings that can clutter the output. The `-fix` option also comes in handy to apply the fixes suggested by the tool but need to ensure that unrelated changes in the file are not committed.
To run clang-tidy on the changed source lines:
```sh