Sqlite and the wallet are no longer optional, but they can still be opted out of. This PR updates the build instructions accordingly.
Updating this text now reduces churn in #31802.
<!--e57a25ab6845829454e8d69fc972939a-->
The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.
<!--006a51241073e994b41acfe9ec718e94-->
For details see: https://corecheck.dev/bitcoin/bitcoin/pulls/33179.
<!--021abf342d371248e50ceaed478a90ca-->
See the guideline for information on the review process.
| Type | Reviewers |
|---|---|
| ACK | w0xlt, pablomartin4btc, jonatack, janb84, achow101 |
If your review is incorrectly listed, please react with 👎 to this comment and the bot will ignore it on the next update.
<!--174a7506f384e20aa4161008e828411d-->
Reviewers, 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.
<!--5faf32d7da4f0f540f40219e4f7537a3-->
17 | + 18 | +```bash 19 | +pkg install sqlite3 20 | +``` 21 | + 22 | +To build Bitcoin Core without wallet, use `-DENABLE_WALLET=OFF`.
To build Bitcoin Core without the wallet, use `-DENABLE_WALLET=OFF`.
Did a replace-all for this one...
35 | + 36 | +```bash 37 | +pkgin sqlite3 38 | +``` 39 | + 40 | +To build Bitcoin Core without wallet, use `-DENABLE_WALLET=OFF`.
To build Bitcoin Core without the wallet, use `-DENABLE_WALLET=OFF`.
17 | + 18 | +```bash 19 | +pkg_add sqlite3 20 | +``` 21 | + 22 | +To build Bitcoin Core without wallet, use `-DENABLE_WALLET=OFF`.
To build Bitcoin Core without the wallet, use `-DENABLE_WALLET=OFF`.
50 | @@ -51,6 +51,14 @@ To install, run the following from your terminal: 51 | brew install cmake boost pkgconf libevent 52 | ``` 53 | 54 | +#### Wallet Dependencies 55 | + 56 | +If you do not need wallet functionality you can use `-DENABLE_WALLET=OFF` in
If you do not need wallet functionality, you can use `-DENABLE_WALLET=OFF` in
50 | @@ -51,6 +51,14 @@ To install, run the following from your terminal: 51 | brew install cmake boost pkgconf libevent 52 | ``` 53 | 54 | +#### Wallet Dependencies 55 | + 56 | +If you do not need wallet functionality you can use `-DENABLE_WALLET=OFF` in 57 | +the `cmake -B` step below. 58 | + 59 | +`sqlite` is required, but since macOS ships with a useable `sqlite` package, you don't need to
SQLite is required, but since macOS ships with a useable `sqlite` package, you don't need to
Approach ACK
Sqlite is expected to be installed, but can still be opted out of.
Applied @jonatack's suggestions.
I slightly reworded the commit message, since technically sqlite is still optional. However since the default cmake incantation will fail without it installed, I do think it's best to move up and out of the "Optional Dependencies" section.
ACK 67e186deb01749ec6a3691d0b763bdc89ab2328f
nit (not a blocker):
build-unix.md is the only build-*.md doc having the Disable-wallet mode section which also explains what use you give to a node without a wallet; this could be replicated to the other OSs build docs for consistency (or the other way around?).-DENABLE_WALLET=OFF/ DVCPKG_MANIFEST_FEATURES) or SQLite (which is being distributed within the OS since Windows 10 I think) - as in build-osx.md one can find: "SQLite is required, but since macOS ships with a useable sqlite package, you don't need to install anything".ACK 67e186deb01749ec6a3691d0b763bdc89ab2328f
or the other way around?
This section feels superfluous at this point, I think it was historically more relevant because BDB was a pain to compile. But I'd rather not do that in this PR.
the Windows build docs
IPC doesn't work on Windows (yet), so I haven't touched those docs at all. I also can't test Windows at the moment.
ACK 67e186deb01749ec6a3691d0b763bdc89ab2328f
PR updates build documents to indicate that SQLite is now a required dependency of the wallet. PR includes all the build docs minus the windows build docs but there is no mention of SQLite or the wallet in those.
ACK 67e186deb01749ec6a3691d0b763bdc89ab2328f
Post-merge ACK 67e186deb01749ec6a3691d0b763bdc89ab2328f.