aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorfanquake <fanquake@gmail.com>2022-03-25 21:04:14 +0000
committerfanquake <fanquake@gmail.com>2022-03-25 21:04:51 +0000
commit2f0f056e08cd5a1435120592a9ecd212fcdb915b (patch)
tree47a5385e7736ce97ea8aac8313c08d9a2cef2c54 /doc
parent6d5771ba07780ac67d5e30108ae6b860f3878e7d (diff)
parent7e22d80af333b202939bcb2631082006c097bf22 (diff)
Merge bitcoin/bitcoin#24665: doc: document clang tidy named args
7e22d80af333b202939bcb2631082006c097bf22 addrman: fix incorrect named args (fanquake) 67f654ef612c8dbefb969e6e67c286ea2c2e82d6 doc: Document clang-tidy in dev notes (MarcoFalke) Pull request description: The documentation, and a single commit extracted from #24661. Motivation: > Incorrect named args are source of bugs, like https://github.com/bitcoin/bitcoin/pull/22979. > To allow them being checked by clang-tidy, use a format it can understand. ACKs for top commit: glozow: ACK 7e22d80af333b202939bcb2631082006c097bf22 Tree-SHA512: 4037fcea59fdf583b171bce7ad350299fe5f9feb3c398413432168f3b9a185e51884d5b30e4b4ab9c6c5bb896c178cfaee1d78d5b4f0034cd70121c9ea4184b7
Diffstat (limited to 'doc')
-rw-r--r--doc/developer-notes.md46
1 files changed, 46 insertions, 0 deletions
diff --git a/doc/developer-notes.md b/doc/developer-notes.md
index bfb64093e1..c3ab3fa953 100644
--- a/doc/developer-notes.md
+++ b/doc/developer-notes.md
@@ -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)
------------------------------------------