mirror of
https://github.com/bitcoin/bitcoin.git
synced 2024-11-19 09:53:47 +01:00
doc: Document clang-tidy in dev notes
This commit is contained in:
parent
95cac21615
commit
67f654ef61
@ -137,11 +137,57 @@ public:
|
||||
} // namespace foo
|
||||
```
|
||||
|
||||
Coding Style (C++ named arguments)
|
||||
------------------------------
|
||||
|
||||
When passing named arguments, use a format that clang-tidy understands. The
|
||||
argument names can otherwise not be verified by clang-tidy.
|
||||
|
||||
For example:
|
||||
|
||||
```c++
|
||||
void function(Addrman& addrman, bool clear);
|
||||
|
||||
int main()
|
||||
{
|
||||
function(g_addrman, /*clear=*/false);
|
||||
}
|
||||
```
|
||||
|
||||
### Running clang-tidy
|
||||
|
||||
To run clang-tidy on Ubuntu/Debian, install the dependencies:
|
||||
|
||||
```sh
|
||||
apt install clang-tidy bear clang
|
||||
```
|
||||
|
||||
Then, pass clang as compiler to configure, and use bear to produce the `compile_commands.json`:
|
||||
|
||||
```sh
|
||||
./autogen.sh && ./configure CC=clang CXX=clang++
|
||||
make clean && bear make -j $(nproc) # For bear 2.x
|
||||
make clean && bear -- make -j $(nproc) # For bear 3.x
|
||||
```
|
||||
|
||||
To run clang-tidy on all source files:
|
||||
|
||||
```sh
|
||||
( cd ./src/ && run-clang-tidy -j $(nproc) )
|
||||
```
|
||||
|
||||
To run clang-tidy on the changed source lines:
|
||||
|
||||
```sh
|
||||
git diff | ( cd ./src/ && clang-tidy-diff -p2 -j $(nproc) )
|
||||
```
|
||||
|
||||
Coding Style (Python)
|
||||
---------------------
|
||||
|
||||
Refer to [/test/functional/README.md#style-guidelines](/test/functional/README.md#style-guidelines).
|
||||
|
||||
|
||||
Coding Style (Doxygen-compatible comments)
|
||||
------------------------------------------
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user