diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/build-unix.md | 4 | ||||
| -rw-r--r-- | doc/dependencies.md | 3 | ||||
| -rw-r--r-- | doc/developer-notes.md | 12 |
3 files changed, 9 insertions, 10 deletions
diff --git a/doc/build-unix.md b/doc/build-unix.md index 45433a32b3..61a66e1c1e 100644 --- a/doc/build-unix.md +++ b/doc/build-unix.md @@ -34,7 +34,7 @@ For the default build type `RelWithDebInfo`, the default compile flags are Finally, clang (often less resource hungry) can be used instead of gcc, which is used by default: - cmake -B build -DCMAKE_CXX_COMPILER=clang++ -DCMAKE_CC_COMPILER=clang + cmake -B build -DCMAKE_CXX_COMPILER=clang++ -DCMAKE_C_COMPILER=clang ## Linux Distribution Specific Instructions @@ -44,7 +44,7 @@ Finally, clang (often less resource hungry) can be used instead of gcc, which is Build requirements: - sudo apt-get install build-essential cmake pkg-config bsdmainutils python3 + sudo apt-get install build-essential cmake pkg-config python3 Now, you can either build from self-compiled [depends](#dependencies) or install the required dependencies: diff --git a/doc/dependencies.md b/doc/dependencies.md index 3bc931e8f6..4c620cf876 100644 --- a/doc/dependencies.md +++ b/doc/dependencies.md @@ -6,9 +6,8 @@ You can find installation instructions in the `build-*.md` file for your platfor | Dependency | Minimum required | | --- | --- | -| [Autoconf](https://www.gnu.org/software/autoconf/) | [2.69](https://github.com/bitcoin/bitcoin/pull/17769) | -| [Automake](https://www.gnu.org/software/automake/) | [1.13](https://github.com/bitcoin/bitcoin/pull/18290) | | [Clang](https://clang.llvm.org) | [16.0](https://github.com/bitcoin/bitcoin/pull/30263) | +| [CMake](https://cmake.org/) | [3.22](https://github.com/bitcoin/bitcoin/pull/30454) | | [GCC](https://gcc.gnu.org) | [11.1](https://github.com/bitcoin/bitcoin/pull/29091) | | [Python](https://www.python.org) (scripts, tests) | [3.9](https://github.com/bitcoin/bitcoin/pull/28211) | | [systemtap](https://sourceware.org/systemtap/) ([tracing](tracing.md))| N/A | 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) |