doc: move cmake -B build -LH up in Unix build docs #33088

pull fanquake wants to merge 1 commits into bitcoin:master from fanquake:rebase_32269 changing 1 files +4 −7
  1. fanquake commented at 10:58 am on July 29, 2025: member

    #32269 rebased.

    I had trouble building bitcoin core the way I wanted since now more features require a flag while building. IMO it makes sense to make it a bit more prominent in the build docs how to get the needed flags.

    Related issue: https://github.com/bitcoin/bitcoin/issues/32258

  2. doc: move `cmake -B build -LH` up in Unix build docs 6757052fc4
  3. DrahtBot added the label Docs on Jul 29, 2025
  4. DrahtBot commented at 10:59 am on July 29, 2025: contributor

    The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

    Code Coverage & Benchmarks

    For details see: https://corecheck.dev/bitcoin/bitcoin/pulls/33088.

    Reviews

    See the guideline for information on the review process.

    Type Reviewers
    ACK stickies-v, maflcko, janb84

    If your review is incorrectly listed, please react with 👎 to this comment and the bot will ignore it on the next update.

  5. stickies-v approved
  6. stickies-v commented at 12:11 pm on July 29, 2025: contributor

    ACK 6757052fc439bedd1fa88ee1d23b4f17cf2c4f7a

    For all other platforms, this configure help lives close to the cmake --build build command, which makes most sense to me. I did note that build-windows.md and build-windows-msvc.md documentation does not provide the cmake -B build -LH help at all. If relevant, could be added in this PR? No blocker.

    Example diff (untested):

     0diff --git a/doc/build-windows-msvc.md b/doc/build-windows-msvc.md
     1index 2d85d223e9..7c07a19850 100644
     2--- a/doc/build-windows-msvc.md
     3+++ b/doc/build-windows-msvc.md
     4@@ -50,6 +50,8 @@ CMake will put the resulting object files, libraries, and executables into a ded
     5 
     6 In the following instructions, the "Debug" configuration can be specified instead of the "Release" one.
     7 
     8+Run `cmake -B build -LH` to see the full list of available options.
     9+
    10 ### 4. Building with Static Linking with GUI
    11 
    12 ```
    13diff --git a/doc/build-windows.md b/doc/build-windows.md
    14index 84db7fa4b5..24c6d06c96 100644
    15--- a/doc/build-windows.md
    16+++ b/doc/build-windows.md
    17@@ -47,9 +47,16 @@ This means you cannot use a directory that is located directly on the host Windo
    18 
    19 Build using:
    20 
    21+```bash
    22     gmake -C depends HOST=x86_64-w64-mingw32  # Append "-j N" for N parallel jobs.
    23     cmake -B build --toolchain depends/x86_64-w64-mingw32/toolchain.cmake
    24+```
    25+
    26+Run `cmake -B build -LH` to see the full list of available options.
    27+
    28+```bash
    29     cmake --build build     # Append "-j N" for N parallel jobs.
    30+```
    31 
    32 ## Depends system
    33 
    
  7. maflcko commented at 12:53 pm on July 29, 2025: member
    lgtm ACK 6757052fc439bedd1fa88ee1d23b4f17cf2c4f7a
  8. janb84 commented at 1:55 pm on July 29, 2025: contributor

    ACK 6757052fc439bedd1fa88ee1d23b4f17cf2c4f7a

    This PR moves information on getting all the available options of cmake -B build to a more prominent place, line 13. The PR seems to me a logical change and makes me wonder why this information was at the end of the documentation in the first place.

  9. fanquake commented at 3:15 pm on July 29, 2025: member
    @stickies-v might follow up with any Windows doc changes.
  10. fanquake merged this on Jul 29, 2025
  11. fanquake closed this on Jul 29, 2025

  12. fanquake deleted the branch on Jul 29, 2025
  13. luke-jr commented at 6:47 am on July 31, 2025: member
    (might make sense to mention ccmake too?)

github-metadata-mirror

This is a metadata mirror of the GitHub repository bitcoin/bitcoin. This site is not affiliated with GitHub. Content is generated from a GitHub metadata backup.
generated: 2025-07-31 21:13 UTC

This site is hosted by @0xB10C
More mirrored repositories can be found on mirror.b10c.me