doc: update unix build doc with build flags #32269

pull bufo24 wants to merge 1 commits into bitcoin:master from bufo24:chore/update-unix-readme-build-flags changing 1 files +7 −7
  1. bufo24 commented at 6:33 pm on April 14, 2025: contributor

    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. DrahtBot commented at 6:33 pm on April 14, 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/32269.

    Reviews

    See the guideline for information on the review process.

    Type Reviewers
    ACK maflcko

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

    Conflicts

    Reviewers, this pull request conflicts with the following ones:

    • #32846 (doc: clarify that the “-j N” goes after the “–build build” part by bigspider)

    If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first.

  3. DrahtBot added the label Docs on Apr 14, 2025
  4. in doc/build-unix.md:15 in 2ca223d282 outdated
     6@@ -7,8 +7,15 @@ Some notes on how to build Bitcoin Core in Unix.
     7 To Build
     8 ---------------------
     9 
    10+### 1. Configuration
    11+
    12 ```bash
    13 cmake -B build
    14+```
    15+Run `cmake -B build -LH` to see the full list of available options.
    


    maflcko commented at 8:13 am on April 15, 2025:

    It doesn’t seem to be unix related, but I don’t have a different suggestion.

    You could also mention something along the lines

    The CMake variables have fixed default values and are not auto-detected at runtime. Any CMake build that requires values different from the defaults must explicitly set them. CMake will print a configure summary, which can be used to verify the build configuration.

    However, this is also not unix specific :shrug:


    bufo24 commented at 8:55 am on April 15, 2025:
    I noticed that this is shown in other build docs except for the unix one, like the macos one here: https://github.com/bitcoin/bitcoin/blob/master/doc/build-osx.md#further-configuration. That’s why I added this more higher up in the doc for unix

    hebasto commented at 8:39 pm on April 15, 2025:

    I noticed that this is shown in other build docs except for the unix one…

    https://github.com/bitcoin/bitcoin/blob/cdc32994feadf3f15df3cfac5baae36b4b011462/doc/build-unix.md?plain=1#L178-L183

  5. DrahtBot added the label CI failed on Apr 28, 2025
  6. DrahtBot removed the label CI failed on May 2, 2025
  7. fanquake commented at 11:40 am on May 13, 2025: member
    As mentioned, what you’re adding is already present in this file, so if you’re re-ordering things, you’ll need to remove the second occurence.
  8. bufo24 commented at 11:42 am on May 13, 2025: contributor
    @fanquake Just did that!
  9. fanquake commented at 11:43 am on May 13, 2025: member
    Thanks. You’ll need to squash your commits.
  10. chore: move `cmake -B build -LH` in unix build be6e4c4db8
  11. bufo24 force-pushed on May 13, 2025
  12. bufo24 commented at 11:45 am on May 13, 2025: contributor
    Done
  13. in doc/build-unix.md:10 in be6e4c4db8
     6@@ -7,8 +7,15 @@ Some notes on how to build Bitcoin Core in Unix.
     7 To Build
     8 ---------------------
     9 
    10+### 1. Configuration
    


    maflcko commented at 2:32 pm on May 13, 2025:
    nit: Not sure we want to manually number the sections. The order should already be clear

    pablomartin4btc commented at 3:40 pm on July 1, 2025:
    I do agree but that’s consistent with most doc/build*.md files (doc/build-freebsd.md, doc/build-netbsd.md, doc/build-openbsd.md, doc/build-osx.md).
  14. maflcko commented at 2:32 pm on May 13, 2025: member
    lgtm ACK be6e4c4db80030aa100cadb68706601eae13c010
  15. DrahtBot added the label Needs rebase on Jul 1, 2025
  16. DrahtBot commented at 8:39 pm on July 1, 2025: contributor
    🐙 This pull request conflicts with the target branch and needs rebase.

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-08 15:13 UTC

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