Skip to content

Commit fa9b1e3

Browse files
committed
Merge bitcoin/bitcoin#32846: doc: clarify that the "-j N" goes after the "--build build" part
0e9f409 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 0e9f409 hebasto: ACK 0e9f409. stickies-v: ACK 0e9f409 pablomartin4btc: ACK 0e9f409 theStack: ACK 0e9f409 brunoerg: ACK 0e9f409 w0xlt: ACK bitcoin/bitcoin@0e9f409 Tree-SHA512: 5283f87a68abae4905b773e73aa4529f52d2302d804165b560b22f300a449d8ce1ae3194d2e1fe69be6f7e4d279dd32b8ef0daa18af4ac6a76a51f5abc39ec63
2 parents b1821d8 + 0e9f409 commit fa9b1e3

File tree

8 files changed

+20
-20
lines changed

8 files changed

+20
-20
lines changed

doc/build-freebsd.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,6 @@ cmake -B build -DENABLE_WALLET=OFF
9595
### 2. Compile
9696

9797
```bash
98-
cmake --build build # Use "-j N" for N parallel jobs.
99-
ctest --test-dir build # Use "-j N" for N parallel tests. Some tests are disabled if Python 3 is not available.
98+
cmake --build build # Append "-j N" for N parallel jobs.
99+
ctest --test-dir build # Append "-j N" for N parallel tests. Some tests are disabled if Python 3 is not available.
100100
```

doc/build-netbsd.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,6 @@ Run `cmake -B build -LH` to see the full list of available options.
110110
Build and run the tests:
111111

112112
```bash
113-
cmake --build build # Use "-j N" for N parallel jobs.
114-
ctest --test-dir build # Use "-j N" for N parallel tests. Some tests are disabled if Python 3 is not available.
113+
cmake --build build # Append "-j N" for N parallel jobs.
114+
ctest --test-dir build # Append "-j N" for N parallel tests. Some tests are disabled if Python 3 is not available.
115115
```

doc/build-openbsd.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,8 +89,8 @@ Run `cmake -B build -LH` to see the full list of available options.
8989
### 2. Compile
9090

9191
```bash
92-
cmake --build build # Use "-j N" for N parallel jobs.
93-
ctest --test-dir build # Use "-j N" for N parallel tests. Some tests are disabled if Python 3 is not available.
92+
cmake --build build # Append "-j N" for N parallel jobs.
93+
ctest --test-dir build # Append "-j N" for N parallel tests. Some tests are disabled if Python 3 is not available.
9494
```
9595

9696
## Resource limits

doc/build-osx.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -182,8 +182,8 @@ After configuration, you are ready to compile.
182182
Run the following in your terminal to compile Bitcoin Core:
183183

184184
``` bash
185-
cmake --build build # Use "-j N" here for N parallel jobs.
186-
ctest --test-dir build # Use "-j N" for N parallel tests. Some tests are disabled if Python 3 is not available.
185+
cmake --build build # Append "-j N" here for N parallel jobs.
186+
ctest --test-dir build # Append "-j N" for N parallel tests. Some tests are disabled if Python 3 is not available.
187187
```
188188

189189
### 3. Deploy (optional)

doc/build-unix.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ To Build
99

1010
```bash
1111
cmake -B build
12-
cmake --build build # use "-j N" for N parallel jobs
13-
cmake --install build # optional
12+
cmake --build build # Append "-j N" for N parallel jobs
13+
cmake --install build # Optional
1414
```
1515

1616
See below for instructions on how to [install the dependencies on popular Linux

doc/build-windows-msvc.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,8 @@ In the following instructions, the "Debug" configuration can be specified instea
5454

5555
```
5656
cmake -B build --preset vs2022-static # It might take a while if the vcpkg binary cache is unpopulated or invalidated.
57-
cmake --build build --config Release # Use "-j N" for N parallel jobs.
58-
ctest --test-dir build --build-config Release # Use "-j N" for N parallel tests. Some tests are disabled if Python 3 is not available.
57+
cmake --build build --config Release # Append "-j N" for N parallel jobs.
58+
ctest --test-dir build --build-config Release # Append "-j N" for N parallel tests. Some tests are disabled if Python 3 is not available.
5959
cmake --install build --config Release # Optional.
6060
```
6161

@@ -74,8 +74,8 @@ cmake -B build --preset vs2022-static -DVCPKG_INSTALL_OPTIONS="--x-buildtrees-ro
7474

7575
```
7676
cmake -B build --preset vs2022 -DBUILD_GUI=OFF # It might take a while if the vcpkg binary cache is unpopulated or invalidated.
77-
cmake --build build --config Release # Use "-j N" for N parallel jobs.
78-
ctest --test-dir build --build-config Release # Use "-j N" for N parallel tests. Some tests are disabled if Python 3 is not available.
77+
cmake --build build --config Release # Append "-j N" for N parallel jobs.
78+
ctest --test-dir build --build-config Release # Append "-j N" for N parallel tests. Some tests are disabled if Python 3 is not available.
7979
```
8080

8181
## Performance Notes

doc/build-windows.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,9 @@ This means you cannot use a directory that is located directly on the host Windo
4747

4848
Build using:
4949

50-
gmake -C depends HOST=x86_64-w64-mingw32 # Use "-j N" for N parallel jobs.
50+
gmake -C depends HOST=x86_64-w64-mingw32 # Append "-j N" for N parallel jobs.
5151
cmake -B build --toolchain depends/x86_64-w64-mingw32/toolchain.cmake
52-
cmake --build build # Use "-j N" for N parallel jobs.
52+
cmake --build build # Append "-j N" for N parallel jobs.
5353

5454
## Depends system
5555

doc/developer-notes.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -532,7 +532,7 @@ cmake -B build -DCMAKE_C_COMPILER="clang" \
532532
-DAPPEND_CFLAGS="-fprofile-instr-generate -fcoverage-mapping" \
533533
-DAPPEND_CXXFLAGS="-fprofile-instr-generate -fcoverage-mapping" \
534534
-DAPPEND_LDFLAGS="-fprofile-instr-generate -fcoverage-mapping"
535-
cmake --build build # Use "-j N" here for N parallel jobs.
535+
cmake --build build # Append "-j N" here for N parallel jobs.
536536
```
537537

538538
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:
542542
mkdir -p build/raw_profile_data
543543

544544
# Run tests to generate profiles
545-
LLVM_PROFILE_FILE="$(pwd)/build/raw_profile_data/%m_%p.profraw" ctest --test-dir build # Use "-j N" here for N parallel jobs.
546-
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
545+
LLVM_PROFILE_FILE="$(pwd)/build/raw_profile_data/%m_%p.profraw" ctest --test-dir build # Append "-j N" here for N parallel jobs.
546+
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
547547

548548
# Merge all the raw profile data into a single file
549549
find build/raw_profile_data -name "*.profraw" | xargs llvm-profdata merge -o build/coverage.profdata
@@ -583,7 +583,7 @@ cmake -B build \
583583
-DCMAKE_C_FLAGS="-fprofile-instr-generate -fcoverage-mapping" \
584584
-DCMAKE_CXX_FLAGS="-fprofile-instr-generate -fcoverage-mapping" \
585585
-DBUILD_FOR_FUZZING=ON
586-
cmake --build build # Use "-j N" here for N parallel jobs.
586+
cmake --build build # Append "-j N" here for N parallel jobs.
587587
```
588588

589589
Running fuzz tests with one or more targets

0 commit comments

Comments
 (0)