Skip to content

Commit 88484f1

Browse files
committed
Merge #1124: Fix code block rendering in 29.0 Release Notes
89d1603 Fix code block rendering (Hennadii Stepanov) Pull request description: On the master branch @ 5626498, the code block is incorrectly rendered as a single line: ![image](https://github.com/user-attachments/assets/8c74bd70-790b-4206-8da4-55fe9f45e3bf) This PR ensures it is displayed correctly over three lines: ![image](https://github.com/user-attachments/assets/94c6231e-16f9-43f9-a293-e9d576d1c721) Numbering has been replaced with bullets, as the rendering engine otherwise restarts numbering from 1 after the code block. ACKs for top commit: achow101: ACK 89d1603 glozow: ACK 89d1603 Tree-SHA512: c01848dfa40c0ee9aabc9fbed842a485b6c0f1246f556c5c4332aa68b99a07c9160177bf572d265ddbe2cbb5071d48e2e3546c8fff36420519b676e0420808da
2 parents 5626498 + 89d1603 commit 88484f1

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

_releases/29.0.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -164,19 +164,25 @@ replace-by-fee the standard behavior. (#30592)
164164

165165
The build system has been migrated from Autotools to CMake:
166166

167-
1. The minimum required CMake version is 3.22.
168-
2. In-source builds are not allowed. When using a subdirectory within the root source tree as a build directory, it is recommended that its name includes the substring "build".
169-
3. CMake variables may be used to configure the build system. **Some defaults have changed.** For example, you will now need to add `-DWITH_ZMQ=ON` to build with zmq and `-DBUILD_GUI=ON` to build `bitcoin-qt`. See [Autotools to CMake Options Mapping](https://github.com/bitcoin-core/bitcoin-devwiki/wiki/Autotools-to-CMake-Options-Mapping) for details.
170-
4. For single-configuration generators, the default build configuration (`CMAKE_BUILD_TYPE`) is "RelWithDebInfo". However, for the "Release" configuration, CMake defaults to the compiler optimization flag `-O3`, which has not been extensively tested with Bitcoin Core. Therefore, the build system replaces it with `-O2`.
171-
5. By default, the built executables and libraries are located in the `bin/` and `lib/` subdirectories of the build directory.
172-
6. The build system supports component‐based installation. The names of the installable components coincide with the build target names. For example:
167+
- The minimum required CMake version is 3.22.
168+
169+
- In-source builds are not allowed. When using a subdirectory within the root source tree as a build directory, it is recommended that its name includes the substring "build".
170+
171+
- CMake variables may be used to configure the build system. **Some defaults have changed.** For example, you will now need to add `-DWITH_ZMQ=ON` to build with zmq and `-DBUILD_GUI=ON` to build `bitcoin-qt`. See [Autotools to CMake Options Mapping](https://github.com/bitcoin-core/bitcoin-devwiki/wiki/Autotools-to-CMake-Options-Mapping) for details.
172+
173+
- For single-configuration generators, the default build configuration (`CMAKE_BUILD_TYPE`) is "RelWithDebInfo". However, for the "Release" configuration, CMake defaults to the compiler optimization flag `-O3`, which has not been extensively tested with Bitcoin Core. Therefore, the build system replaces it with `-O2`.
174+
175+
- By default, the built executables and libraries are located in the `bin/` and `lib/` subdirectories of the build directory.
176+
177+
- The build system supports component‐based installation. The names of the installable components coincide with the build target names. For example:
178+
173179
```
174180
cmake -B build
175181
cmake --build build --target bitcoind
176182
cmake --install build --component bitcoind
177183
```
178184

179-
7. If any of the `CPPFLAGS`, `CFLAGS`, `CXXFLAGS` or `LDFLAGS` environment variables were used in your Autotools-based build process, you should instead use the corresponding CMake variables (`APPEND_CPPFLAGS`, `APPEND_CFLAGS`, `APPEND_CXXFLAGS` and `APPEND_LDFLAGS`). Alternatively, if you opt to use the dedicated `CMAKE_<...>_FLAGS` variables, you must ensure that the resulting compiler or linker invocations are as expected.
185+
- If any of the `CPPFLAGS`, `CFLAGS`, `CXXFLAGS` or `LDFLAGS` environment variables were used in your Autotools-based build process, you should instead use the corresponding CMake variables (`APPEND_CPPFLAGS`, `APPEND_CFLAGS`, `APPEND_CXXFLAGS` and `APPEND_LDFLAGS`). Alternatively, if you opt to use the dedicated `CMAKE_<...>_FLAGS` variables, you must ensure that the resulting compiler or linker invocations are as expected.
180186

181187
For more detailed guidance on configuring and using CMake, please refer to the official [CMake documentation](https://cmake.org/cmake/help/latest/) and [CMake’s User Interaction Guide](https://cmake.org/cmake/help/latest/guide/user-interaction/index.html). Additionally, consult platform-specific `doc/build-*.md` build guides for instructions tailored to your operating system.
182188

0 commit comments

Comments
 (0)