#36612 doc: Merge all BSD build docs back into build-unix.md

ReviewabilityReviewsAgreementSize
#36612 maflcko doc: Merge all BSD build docs back into build-unix.mdReady1Positive41
  • Avoid maintaining duplicate build instructions across separate BSD documents
  • Reduces maintenance overhead when build system instructions change
  • Ready to review
  • Approval without stated reasons (hebasto)
  • Clarification on integrating NetBSD notes was answered by author (hebasto)
  • 41 lines added or modified outside tests
  • 0 lines added or modified in tests
  • 347 lines removed in total
  • 6 files, 2 commits
Documentation#9 of 9
P4 · cleanup
  • P4 because it is a routine cleanup deduplicating boilerplate across BSD guides
  • Does not fix incorrect build instructions or document missing features
Ranking notes
Reviewability: ReadyStalePaused
Agreement: StrongPositivePositive w/ caveatsNeutralMildDisputedBlockedCrickets
Reviews: current code-review ACKs, then (+stale ACKs) and -NACKs; greener = more ACKs.
Size: lines added or modified outside tests, then in tests; greener = smaller.

Goal

Consolidates individual FreeBSD, NetBSD, and OpenBSD build guides into doc/build-unix.md and deletes the standalone BSD documents. It integrates OS-specific package manager dependencies into the Unix dependency table and moves the OpenBSD ulimit note into the general memory requirements section.

Problem: Maintaining separate BSD documentation files duplicates boilerplate CMake build instructions and configuration details across multiple files, increasing maintenance effort whenever build instructions change.

Evidence of importance:

  • Author states in PR description that BSD docs 'all include the same redundant boilerplate cmake commands and doc snippets' and 'updating the build system requires identical changes over many files.'

Scope: Deletes doc/build-freebsd.md, doc/build-netbsd.md, and doc/build-openbsd.md, consolidating their package installation tables and memory limit notes into doc/build-unix.md.

Risk of a mistake: low (docs). Incorrect documentation could lead to broken build instructions or missing dependencies for BSD users.

Changed since the previous assessment: Diff provided matches the previous summary; no functional or structural changes to the PR.

Reviewability

Ready

Nothing known that would invalidate a review now.

Waiting on (from the thread read):

  • nothing: nothing pending; previous question answered and reviewer has approved

Agreement

Positive

support without stated reasons, no open objection (hebasto)

Thread notes: hebasto approved the PR with an ACK.

Objections, suggestions, and questions:

ReviewerTypeHarm, request, or questionStatusMust beAuthor repliedQuote
hebasto (member)question, scopeCan the instructions from PR 36042 comment 6339790516 be easily integrated into the new Build Notes?answered · author replied that listing the package is trivial and offered to document the compiler flags if neededansweredyes2026-10-23: 'I'm wondering whether https://github.com/bitcoin/bitcoin/pull/36042#issuecomment-6339790516 can be easily integrated into the new Build Notes?'
Status from: 2026-10-23: maflcko: 'Yes, it should be a trivial addition to list `pkgin install gcc14` in the table (or any other version).'

Support:

  • hebasto (member) (ACK, 2026-10-27): I have reviewed the code and it looks OK. [not substantive]

Participants:

  • hebasto (member, support, 2 statements 2026-10-23 to 2026-10-27): asked about integrating NetBSD build notes, then ACKed

Files

0 lines under test/bench/ci.

  • doc/build-openbsd.md +0/-116
  • doc/build-freebsd.md +0/-100
  • doc/build-netbsd.md +0/-98
  • doc/build-unix.md +40/-29
  • doc/README.md +0/-3
  • src/qt/README.md +1/-1

Card

The short text the ranking pass compares across PRs.

Merges separate FreeBSD, NetBSD, and OpenBSD build documents into build-unix.md and removes the standalone BSD guide files. This eliminates redundant CMake boilerplate and reduces maintenance overhead when updating build system instructions. Evidence is limited to author claims about documentation maintenance overhead, with no linked issue. It has no dependencies.

Data

dossier JSON · extract JSON · model ledger, generated 2026-10-28T01:23, confidence high, input hash cbb7531bb69d686d
thread read through 2026-10-27 (3 statements), head 22226d2a2d
labels: Docs

Categories

Documentation

P4 · cleanup

Deduplicates build instructions across BSD guides into a single Unix document to reduce maintenance boilerplate. It does not correct misleading instructions or document missing features, making it a low-priority documentation cleanup.

Membership: Carries Docs label and consolidates BSD build guides into doc/build-unix.md.

Factors: security/stability 0, bug 0, performance 0, user value 0, leverage 0