diff options
| author | merge-script <fanquake@gmail.com> | 2024-08-29 10:53:11 +0100 |
|---|---|---|
| committer | merge-script <fanquake@gmail.com> | 2024-08-29 10:53:11 +0100 |
| commit | 8f761ea742e69b8e7878b601a0d2efb23c3fe323 (patch) | |
| tree | bab2fa7b7cb4c9822cef40ad9a91f8d59dac9727 | |
| parent | 00ad716c2b6a90ec8aeb54d5cebe93e86c371c0d (diff) | |
| parent | 7de0c99804bca98ef159b7b778e6f5b602507d2c (diff) | |
Merge bitcoin/bitcoin#30739: doc: update dev note examples for CMake
7de0c99804bca98ef159b7b778e6f5b602507d2c doc: update dev note examples for CMake (fanquake)
Pull request description:
Update the examples in the developer notes to work with CMake.
Also added an explicit `-DCMAKE_EXPORT_COMPILE_COMMANDS=ON` for clarity.
ACKs for top commit:
davidgumberg:
Tested ACK https://github.com/bitcoin/bitcoin/commit/7de0c99804bca98ef159b7b778e6f5b602507d2c
TheCharlatan:
ACK 7de0c99804bca98ef159b7b778e6f5b602507d2c
jonatack:
Tested ACK 7de0c99804bca98ef159b7b778e6f5b602507d2c on arm64 macOS 14.6.1
Tree-SHA512: 561fe5e777c5b29a4f26309700c03a730c5bbb2f838630abfaa4174112ced66e733c2109cb429a1927f1f3692bf1945f6386bcaffe604a76ea24633932d39171
| -rw-r--r-- | doc/developer-notes.md | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/developer-notes.md b/doc/developer-notes.md index 3066aabe60..99c263bed5 100644 --- a/doc/developer-notes.md +++ b/doc/developer-notes.md @@ -214,14 +214,14 @@ int main() To run clang-tidy on Ubuntu/Debian, install the dependencies: ```sh -apt install clang-tidy bear clang +apt install clang-tidy clang ``` -Then, pass clang as compiler to configure, and use bear to produce the `compile_commands.json`: +Configure with clang as the compiler: ```sh -./autogen.sh && ./configure CC=clang CXX=clang++ -make clean && bear --config src/.bear-tidy-config -- make -j $(nproc) +cmake -B build -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++ -DCMAKE_EXPORT_COMPILE_COMMANDS=ON +cmake --build build -j $(nproc) ``` The output is denoised of errors from external dependencies. @@ -229,13 +229,13 @@ The output is denoised of errors from external dependencies. To run clang-tidy on all source files: ```sh -( cd ./src/ && run-clang-tidy -j $(nproc) ) +( cd ./src/ && run-clang-tidy -p ../build -j $(nproc) ) ``` To run clang-tidy on the changed source lines: ```sh -git diff | ( cd ./src/ && clang-tidy-diff -p2 -j $(nproc) ) +git diff | ( cd ./src/ && clang-tidy-diff -p2 -path ../build -j $(nproc) ) ``` Coding Style (Python) |