doc: Remove Boost build note from build-unix.md #23469
Conversation
We don't do this for any other dependency, and users are better looking at the actual Boost site/docs. This isn't something we should need to have in our build docs.
Calling dependencies optional in a list of already optional dependencies is redundant.
There was a problem hiding this comment.
Concept ACK
It makes sense to remove Boost build notes, as:
- As mentioned by @fanquake, build notes are not maintained for other libraries.
- Building Boost yourself is not an immediate necessity to compiling bitcoin.
- The official documentation of building boost is quite good and easy to follow through, so we don’t need to explain it on our docs.
However, removing Boost build notes intuitively kind of seems off to me. I would like to listen to other reviewers’ opinions before making a final decision.
As for removing unnecessary “optional,” I am ACK on that. Cheers!
|
The following sections might be updated with supplementary metadata relevant to reviewers and maintainers. ConflictsReviewers, this pull request conflicts with the following ones:
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. |
|
@shaavan no informed opinion myself but I'd flip the question: would you ACK the addition of these docs? |
|
I think our recommended way to use dependencies is system packages or depends. I wasn't aware there is even a doc on how to build boost separately. And I am still not entirely sure why we have the build_bdb script, given that there is depends. cr ACK |
|
It looks like the note on building boost was added before the depends system. |
|
So QR is now required, right? |
No. |
|
ACK. |
|
Unless it's a recent thing, there's no need to bootstrap Boost as root. |
ea360d6 doc: remove redundant optionals from build-unix.md (fanquake) b971858 doc: remove Boost build note from build-unix.md (fanquake) Pull request description: We don't have build instructions for any other dependency, and in any case, this isn't something we should maintain in our docs. If someone wants to know how to build Boost, or any other dependency, they can look at the relevant website / external build documentation. ACKs for top commit: jarolrod: ACK ea360d6 Tree-SHA512: c7389b5f051f79c728d8ea0725143affeb2c35b1e3c20d5cd441c6ac540d230698c47bf2c57feb12e7b6bffd2f337c1c83a9cd3a928ce5c479cdbbdf8f61fba4
We don't have build instructions for any other dependency, and in any case, this isn't something we should maintain in our docs. If someone wants to know how to build Boost, or any other dependency, they can look at the relevant website / external build documentation.