Merge bitcoin/bitcoin#32846: doc: clarify that the "-j N" goes after the "--build build" part

0e9f409db3b7b08aef75ce39765b018b69cc8e9d doc: clarify that the "-j N" goes after the "--build build" part (Salvatore Ingala)

Pull request description:

  I was surprised that something like `cmake -j 4 --build build` doesn't work, so this might help others to not make the same mistake.

ACKs for top commit:
  achow101:
    ACK 0e9f409db3b7b08aef75ce39765b018b69cc8e9d
  hebasto:
    ACK 0e9f409db3b7b08aef75ce39765b018b69cc8e9d.
  stickies-v:
    ACK 0e9f409db3b7b08aef75ce39765b018b69cc8e9d
  pablomartin4btc:
    ACK 0e9f409db3b7b08aef75ce39765b018b69cc8e9d
  theStack:
    ACK 0e9f409db3b7b08aef75ce39765b018b69cc8e9d
  brunoerg:
    ACK 0e9f409db3b7b08aef75ce39765b018b69cc8e9d
  w0xlt:
    ACK 0e9f409db3

Tree-SHA512: 5283f87a68abae4905b773e73aa4529f52d2302d804165b560b22f300a449d8ce1ae3194d2e1fe69be6f7e4d279dd32b8ef0daa18af4ac6a76a51f5abc39ec63
This commit is contained in:
Ava Chow 2025-07-01 11:56:37 -07:00
commit fa9b1e3544
No known key found for this signature in database
GPG Key ID: 17565732E08E5E41
8 changed files with 20 additions and 20 deletions

View File

@ -95,6 +95,6 @@ cmake -B build -DENABLE_WALLET=OFF
### 2. Compile
```bash
cmake --build build # Use "-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.
cmake --build build # Append "-j N" for N parallel jobs.
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:
```bash
cmake --build build # Use "-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.
cmake --build build # Append "-j N" for N parallel jobs.
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
```bash
cmake --build build # Use "-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.
cmake --build build # Append "-j N" for N parallel jobs.
ctest --test-dir build # Append "-j N" for N parallel tests. Some tests are disabled if Python 3 is not available.
```
## 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:
``` bash
cmake --build build # Use "-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.
cmake --build build # Append "-j N" here for N parallel jobs.
ctest --test-dir build # Append "-j N" for N parallel tests. Some tests are disabled if Python 3 is not available.
```
### 3. Deploy (optional)

View File

@ -9,8 +9,8 @@ To Build
```bash
cmake -B build
cmake --build build # use "-j N" for N parallel jobs
cmake --install build # optional
cmake --build build # Append "-j N" for N parallel jobs
cmake --install build # Optional
```
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 --build build --config Release # Use "-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.
cmake --build build --config Release # Append "-j N" for N parallel jobs.
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.
```
@ -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 --build build --config Release # Use "-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.
cmake --build build --config Release # Append "-j N" for N parallel jobs.
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

View File

@ -47,9 +47,9 @@ This means you cannot use a directory that is located directly on the host Windo
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 --build build # Use "-j N" for N parallel jobs.
cmake --build build # Append "-j N" for N parallel jobs.
## Depends system

View File

@ -532,7 +532,7 @@ cmake -B build -DCMAKE_C_COMPILER="clang" \
-DAPPEND_CFLAGS="-fprofile-instr-generate -fcoverage-mapping" \
-DAPPEND_CXXFLAGS="-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:
@ -542,8 +542,8 @@ Generating the raw profile data based on `ctest` and functional tests execution:
mkdir -p build/raw_profile_data
# 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" 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" 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 # Append "-j N" here for N parallel jobs
# 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
@ -583,7 +583,7 @@ cmake -B build \
-DCMAKE_C_FLAGS="-fprofile-instr-generate -fcoverage-mapping" \
-DCMAKE_CXX_FLAGS="-fprofile-instr-generate -fcoverage-mapping" \
-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