1
1
mirror of https://github.com/bitcoin/bitcoin synced 2025-10-06 04:12:57 +02:00

doc: clarify that the "-j N" goes after the "--build build" part

Also, capitalized the comments in build-unix.md for uniformity
with the docs on other targets.
This commit is contained in:
Salvatore Ingala
2025-07-01 09:20:36 +02:00
parent 23a00fcf57
commit 0e9f409db3
8 changed files with 20 additions and 20 deletions

View File

@@ -95,6 +95,6 @@ cmake -B build -DENABLE_WALLET=OFF
### 2. Compile ### 2. Compile
```bash ```bash
cmake --build build # Use "-j N" for N parallel jobs. cmake --build build # Append "-j N" for N parallel jobs.
ctest --test-dir build # Use "-j N" for N parallel tests. Some tests are disabled if Python 3 is not available. ctest --test-dir build # Append "-j N" for N parallel tests. Some tests are disabled if Python 3 is not available.
``` ```

View File

@@ -110,6 +110,6 @@ Run `cmake -B build -LH` to see the full list of available options.
Build and run the tests: Build and run the tests:
```bash ```bash
cmake --build build # Use "-j N" for N parallel jobs. cmake --build build # Append "-j N" for N parallel jobs.
ctest --test-dir build # Use "-j N" for N parallel tests. Some tests are disabled if Python 3 is not available. ctest --test-dir build # Append "-j N" for N parallel tests. Some tests are disabled if Python 3 is not available.
``` ```

View File

@@ -89,8 +89,8 @@ Run `cmake -B build -LH` to see the full list of available options.
### 2. Compile ### 2. Compile
```bash ```bash
cmake --build build # Use "-j N" for N parallel jobs. cmake --build build # Append "-j N" for N parallel jobs.
ctest --test-dir build # Use "-j N" for N parallel tests. Some tests are disabled if Python 3 is not available. ctest --test-dir build # Append "-j N" for N parallel tests. Some tests are disabled if Python 3 is not available.
``` ```
## Resource limits ## Resource limits

View File

@@ -182,8 +182,8 @@ After configuration, you are ready to compile.
Run the following in your terminal to compile Bitcoin Core: Run the following in your terminal to compile Bitcoin Core:
``` bash ``` bash
cmake --build build # Use "-j N" here for N parallel jobs. cmake --build build # Append "-j N" here for N parallel jobs.
ctest --test-dir build # Use "-j N" for N parallel tests. Some tests are disabled if Python 3 is not available. ctest --test-dir build # Append "-j N" for N parallel tests. Some tests are disabled if Python 3 is not available.
``` ```
### 3. Deploy (optional) ### 3. Deploy (optional)

View File

@@ -9,8 +9,8 @@ To Build
```bash ```bash
cmake -B build cmake -B build
cmake --build build # use "-j N" for N parallel jobs cmake --build build # Append "-j N" for N parallel jobs
cmake --install build # optional cmake --install build # Optional
``` ```
See below for instructions on how to [install the dependencies on popular Linux See below for instructions on how to [install the dependencies on popular Linux

View File

@@ -54,8 +54,8 @@ In the following instructions, the "Debug" configuration can be specified instea
``` ```
cmake -B build --preset vs2022-static # It might take a while if the vcpkg binary cache is unpopulated or invalidated. cmake -B build --preset vs2022-static # It might take a while if the vcpkg binary cache is unpopulated or invalidated.
cmake --build build --config Release # Use "-j N" for N parallel jobs. cmake --build build --config Release # Append "-j N" for N parallel jobs.
ctest --test-dir build --build-config Release # Use "-j N" for N parallel tests. Some tests are disabled if Python 3 is not available. ctest --test-dir build --build-config Release # Append "-j N" for N parallel tests. Some tests are disabled if Python 3 is not available.
cmake --install build --config Release # Optional. cmake --install build --config Release # Optional.
``` ```
@@ -74,8 +74,8 @@ cmake -B build --preset vs2022-static -DVCPKG_INSTALL_OPTIONS="--x-buildtrees-ro
``` ```
cmake -B build --preset vs2022 -DBUILD_GUI=OFF # It might take a while if the vcpkg binary cache is unpopulated or invalidated. cmake -B build --preset vs2022 -DBUILD_GUI=OFF # It might take a while if the vcpkg binary cache is unpopulated or invalidated.
cmake --build build --config Release # Use "-j N" for N parallel jobs. cmake --build build --config Release # Append "-j N" for N parallel jobs.
ctest --test-dir build --build-config Release # Use "-j N" for N parallel tests. Some tests are disabled if Python 3 is not available. ctest --test-dir build --build-config Release # Append "-j N" for N parallel tests. Some tests are disabled if Python 3 is not available.
``` ```
## Performance Notes ## Performance Notes

View File

@@ -47,9 +47,9 @@ This means you cannot use a directory that is located directly on the host Windo
Build using: Build using:
gmake -C depends HOST=x86_64-w64-mingw32 # Use "-j N" for N parallel jobs. gmake -C depends HOST=x86_64-w64-mingw32 # Append "-j N" for N parallel jobs.
cmake -B build --toolchain depends/x86_64-w64-mingw32/toolchain.cmake cmake -B build --toolchain depends/x86_64-w64-mingw32/toolchain.cmake
cmake --build build # Use "-j N" for N parallel jobs. cmake --build build # Append "-j N" for N parallel jobs.
## Depends system ## Depends system

View File

@@ -532,7 +532,7 @@ cmake -B build -DCMAKE_C_COMPILER="clang" \
-DAPPEND_CFLAGS="-fprofile-instr-generate -fcoverage-mapping" \ -DAPPEND_CFLAGS="-fprofile-instr-generate -fcoverage-mapping" \
-DAPPEND_CXXFLAGS="-fprofile-instr-generate -fcoverage-mapping" \ -DAPPEND_CXXFLAGS="-fprofile-instr-generate -fcoverage-mapping" \
-DAPPEND_LDFLAGS="-fprofile-instr-generate -fcoverage-mapping" -DAPPEND_LDFLAGS="-fprofile-instr-generate -fcoverage-mapping"
cmake --build build # Use "-j N" here for N parallel jobs. cmake --build build # Append "-j N" here for N parallel jobs.
``` ```
Generating the raw profile data based on `ctest` and functional tests execution: Generating the raw profile data based on `ctest` and functional tests execution:
@@ -542,8 +542,8 @@ Generating the raw profile data based on `ctest` and functional tests execution:
mkdir -p build/raw_profile_data mkdir -p build/raw_profile_data
# Run tests to generate profiles # Run tests to generate profiles
LLVM_PROFILE_FILE="$(pwd)/build/raw_profile_data/%m_%p.profraw" ctest --test-dir build # Use "-j N" here for N parallel jobs. LLVM_PROFILE_FILE="$(pwd)/build/raw_profile_data/%m_%p.profraw" ctest --test-dir build # Append "-j N" here for N parallel jobs.
LLVM_PROFILE_FILE="$(pwd)/build/raw_profile_data/%m_%p.profraw" build/test/functional/test_runner.py # Use "-j N" here for N parallel jobs LLVM_PROFILE_FILE="$(pwd)/build/raw_profile_data/%m_%p.profraw" build/test/functional/test_runner.py # Append "-j N" here for N parallel jobs
# Merge all the raw profile data into a single file # Merge all the raw profile data into a single file
find build/raw_profile_data -name "*.profraw" | xargs llvm-profdata merge -o build/coverage.profdata find build/raw_profile_data -name "*.profraw" | xargs llvm-profdata merge -o build/coverage.profdata
@@ -583,7 +583,7 @@ cmake -B build \
-DCMAKE_C_FLAGS="-fprofile-instr-generate -fcoverage-mapping" \ -DCMAKE_C_FLAGS="-fprofile-instr-generate -fcoverage-mapping" \
-DCMAKE_CXX_FLAGS="-fprofile-instr-generate -fcoverage-mapping" \ -DCMAKE_CXX_FLAGS="-fprofile-instr-generate -fcoverage-mapping" \
-DBUILD_FOR_FUZZING=ON -DBUILD_FOR_FUZZING=ON
cmake --build build # Use "-j N" here for N parallel jobs. cmake --build build # Append "-j N" here for N parallel jobs.
``` ```
Running fuzz tests with one or more targets Running fuzz tests with one or more targets