doc: Add documentation explaining different build types #33355

pull jalateras wants to merge 3 commits into bitcoin:master from jalateras:doc-build-types changing 4 files +417 −0
  1. jalateras commented at 6:37 am on September 10, 2025: none

    Summary

    This PR adds documentation explaining the different types of Bitcoin Core binaries available for download, addressing the confusion expressed in issue #33316.

    Problem

    Users downloading Bitcoin Core encounter various file types (unsigned, signed, debug, codesigning) without clear documentation explaining what each version means or which one they should use.

    Solution

    Added a new doc/build-types.md file that comprehensively explains:

    • Unsigned builds: Raw build outputs before signing
    • Signed/codesigned builds: Standard release binaries with platform signatures
    • Debug builds: Builds with debugging symbols
    • Codesigning archives: Special packages for the release process
    • File formats by platform (Windows, macOS, Linux)
    • Verification instructions

    The documentation is written to be accessible to end users while still providing technical details where appropriate.

    Changes

    • Added new file doc/build-types.md with comprehensive build type documentation
    • Added reference to the new document in doc/README.md under the Building section

    Fixes #33316

    Testing

    Documentation only change - no code changes requiring testing.

  2. doc: Add documentation explaining different build types
    This adds a new doc/build-types.md file that explains the different
    types of Bitcoin Core binaries available for download (unsigned, signed,
    debug, codesigning). This addresses user confusion about what these
    different file types mean and which ones they should download.
    
    The documentation covers:
    - Unsigned builds (raw build outputs before signing)
    - Signed/codesigned builds (standard release binaries)
    - Debug builds (with debugging symbols)
    - Codesigning archives (for release process)
    - File formats by platform
    - Verification instructions
    
    Also adds a reference to the new document in doc/README.md.
    
    Fixes #33316
    517f4f3340
  3. DrahtBot added the label Docs on Sep 10, 2025
  4. DrahtBot commented at 6:37 am on September 10, 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/33355.

    Reviews

    See the guideline for information on the review process. A summary of reviews will appear here.

    LLM Linter (✨ experimental)

    Possible typos and grammar issues:

    • OP_PUSHDATA4: Pushes up to 4GB bytes (length in next 4 bytes) -> OP_PUSHDATA4: Pushes up to 4 GB (length in next 4 bytes) [“4GB bytes” is redundant/incorrect; use “4 GB” or “4 gigabytes” to be clear]

    drahtbot_id_5_m

  5. doc: Improve build types documentation placement and fix typos
    This commit improves the build-types.md documentation by:
    
    1. Moving the reference from the "Building" section to the "Setup"
       section in doc/README.md, as this documentation is primarily for
       end users downloading binaries rather than developers building
       from source.
    
    2. Fixing filename pattern inconsistencies by adding wildcards (*)
       to -setup.exe and -debug files to match the pattern used for
       other file types.
    
    These changes improve discoverability for users looking for information
    about which binary type to download.
    2674e12ac5
  6. fix(doc): add missing trailing newline to build-types.md 3baaf6deb5


jalateras DrahtBot

Labels
Docs


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-09-12 12:13 UTC

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