doc: rewrite OpenBSD build docs for 7.0#24652
Conversation
There was a problem hiding this comment.
Concept ACK 33f946b
I like the idea of keeping consistency in the markdown across build docs.
fanquake
force-pushed
the
openbsd_wallet_doc_cleanupp
branch
from
33f946b to
d7fd6cc
Compare
|
@shaavan you might be interested in reviewing? |
shaavan
left a comment
shaavan
left a comment
There was a problem hiding this comment.
Concept ACK
I like this rewriting of the OpenBSD documentation for the following reasons:
- It effectively uses the # tags to properly segregate subsections into logical units.
- Updates the example package versions to the latest one.
- Removes redundant information from wherever possible.
- Properly structure the documentation into a logical flow, from preparations to building specific wallet support.
I want to suggest some minor changes that might help improve this documentation.
- I think we should not be giving version numbers in examples as this might incur a maintenance burden on the documentation as time passes.
Removes redundant notes for setting CC & CXX now that Clang is well and truly the base compiler. Cleans up the wallet docs, i.e bitcoin#23446. Make the notes more similar to FreeBSD.
fanquake
force-pushed
the
openbsd_wallet_doc_cleanupp
branch
from
d7fd6cc to
a2b56dc
Compare
|
Concept ACK.
Nice. I had in mind to do this as well for a while.
I agree in general. However not sure which version you're referring to exactly;
|
| `sqlite3` is required to support [descriptor wallets](descriptors.md). | ||
|
|
||
| ``` bash | ||
| pkg_add install sqlite3 |
There was a problem hiding this comment.
Having all the pkg_add under one section (split up into subsections for different needs) might be slightly more handy. Dunno. I usually like to do it at once (as root) when following the instructions.
There was a problem hiding this comment.
I agree that having everything in a single line to copy-paste and install might be more convenient. I'm just following the existing docs, which seem to have everything split out into separate sections.
|
@shaavan want to take another look? |
shaavan
left a comment
shaavan
left a comment
There was a problem hiding this comment.
ACK a2b56dc
Changes since my last review:
- Removed the example version number from the
pkg_addcommand and made subsequent minor changes. - Reworded commands and comments under the Building Bitcoin core subheading.
Removing the example version made the code snippet relatively clean and concise while still making the user aware of installing the latest version.
I agree with the new rewording of the Building Bitcoin core code snippet section for the following reasons:
- It made the code snippet relatively brief, making it clear to understand.
- Though “major.minor only” seemed quite cryptic at first, the following code lines clarified what it meant, removing the need for redundant example comments.
5 participants
Removes redundant notes for setting
CC&CXXnow that Clang is well and truly the base compiler. See: https://www.openbsd.org/70.htmlCleans up the wallet docs, i.e #23446.
Make the notes more similar to the FreeBSD notes.