doc: Add documentation explaining different build types #33355

pull jalateras wants to merge 1 commits into bitcoin:master from jalateras:doc-build-types changing 2 files +108 −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

    AI-Generated Code

    Some portions of the code in this PR were generated using Claude Code Cli

    Testing

    Documentation only change - no code changes requiring testing.

  2. DrahtBot added the label Docs on Sep 10, 2025
  3. 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.

    Type Reviewers
    Concept NACK TheCharlatan

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

  4. janb84 commented at 3:53 pm on September 15, 2025: contributor
  5. jalateras force-pushed on Sep 15, 2025
  6. jalateras commented at 9:54 pm on September 15, 2025: none
    @janb84 squashed and pushed
  7. janb84 commented at 8:40 am on September 16, 2025: contributor

    Please:

    • remove the .claude folder and contents
    • change pr description or remove the “How Bitcoin’s Script Virtual Machine Works” document

    As an additional note, please declare the usage of the AI, if applicable.

  8. 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
    9672216182
  9. jalateras force-pushed on Sep 16, 2025
  10. jalateras commented at 9:01 am on September 16, 2025: none

    @janb84

    1. I have removed unrelated files
    2. I have squashed and pushed
    3. I have added an AI declaration in the PR
  11. TheCharlatan commented at 9:17 am on September 16, 2025: contributor

    NACK

    Besides reading heavily AI-generated, this information does not seem useful, since it does not describe concretely how to actually make use of any of our shipped build artefacts.

  12. achow101 commented at 8:53 pm on September 17, 2025: member
    Please stop using LLMs to generate PRs.
  13. achow101 closed this on Sep 17, 2025


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

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