doc: FreeBSD build doc updates to reflect removal of install_db4.sh #26773

pull murrayn wants to merge 1 commits into bitcoin:master from murrayn:use_db4_on_freebsd changing 1 files +26 −9

murrayn commented at 7:43 AM on December 30, 2022: contributor

This PR introduces documentation changes needed to keep up with #26834.
DrahtBot commented at 7:44 AM on December 30, 2022: contributor



The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.



Reviews

See the guideline for information on the review process.

Type Reviewers

ACK fanquake

If your review is incorrectly listed, please react with 👎 to this comment and the bot will ignore it on the next update.
DrahtBot added the label Docs on Dec 30, 2022
in doc/build-freebsd.md:43 in f0367cb2d5 outdated
```
  40 | +`db4` is only required to support legacy wallets.
  41 |  Skip if you don't intend to use legacy wallets.
  42 |  
  43 |  ```bash
  44 | -pkg install db5
  45 | +./contrib/install_db4.sh `pwd`
```
maflcko commented at 9:53 AM on December 30, 2022:

Some users read the docs from master, even if they compile a previous release. So they'd run into issues, due to https://github.com/bitcoin/bitcoin/pull/26772

murrayn commented at 12:33 PM on December 30, 2022:

Thanks for commenting. I can see how building a previous release using master docs as a guide may result in running into issues. In that case, hopefully a search for the error would find #26774. But as mentioned here https://github.com/bitcoin/bitcoin/blob/65de8eeeca29e71378aa34602b287ab921b040e4/doc/build-unix.md?plain=1#L68 and here https://github.com/bitcoin/bitcoin/blob/65de8eeeca29e71378aa34602b287ab921b040e4/doc/build-openbsd.md?plain=1#L43 building with db5 will break compatibility with legacy wallets which is more problematic. #26772 aside, this doc should probably be updated.

maflcko commented at 2:00 PM on December 30, 2022:

This shouldn't be an issue, see https://github.com/bitcoin/bitcoin/pull/18870
murrayn commented at 12:35 PM on January 5, 2023:

My takeaway from #18870 is that it supports this PR. As @achow101 stated when he closed it:

This seems to still be a bit problematic because of those transaction logs. So closing for now.

It's entirely possible I'm missing something, but advising someone needing legacy wallet support to build with db5 seems to go down the wrong path and build docs for platforms other than FreeBSD address this. Do you think adding more rationale in the document would be helpful?
maflcko commented at 12:43 PM on January 5, 2023:

yeah, my understanding is that you don't have logs in normal operation, so this shouldn't be an issue in normal operation. And not normal operation isn't supported by this software project.

No strong opinion either way. I think anything is fine here, I just left a comment.
murrayn marked this as a draft on Jan 4, 2023
murrayn marked this as ready for review on Jan 6, 2023
fanquake commented at 10:09 AM on January 6, 2023: member

See #26834. Would rather not add more usage of install_db4.sh.
murrayn commented at 12:24 PM on January 12, 2023: contributor

See #26834. Would rather not add more usage of install_db4.sh.

Yes, but meanwhile the doc is incorrect.
jarolrod commented at 5:51 AM on January 13, 2023: member

no strong opinion

There's sometimes unsaid knowledge in some of these docs, and we can do a much better job of figuring out what is all the information people need to know and organize it effectively. As someone who's worked on the bsd docs, in my head the doc recommends db5 because the doc is meant to guide a user through a dynamic compile using packages they install with their package manager. There's many ways to compile core, and people need to make their own decisions as to how they want to accomplish the task.

The install_db4 script is meant for when there's no easy way to get a bin from a package manager and as a last resort option because you really don't want any static builds. Additionally, There are plans to move away from any bdb support, but that's further out. Descriptor wallets use sqlite.

Debating whether to use db5 or db4 without patches that we need (in depends) isn't so useful when, given the circumstances of this dependency, the recommendation should be to build it using depends.

Now, I would say that we could include a note here to build bdb with depends and then configure with the bdb prefix, but this would end up duplicated across the build docs for other systems where there is no db4 package.
murrayn commented at 11:02 AM on January 13, 2023: contributor

The install_db4 script is meant for when there's no easy way to get a bin from a package manager

install_db4.sh is called for here because db4 is not available in package managers (or the ports system in the case of *BSD), but is required for legacy wallet support.

Debating whether to use db5 or db4

This is not the debate. db4 should be used for legacy wallet support. The section of the documentation we are discussing is specifically for legacy wallet support, and it is currently incorrect.

I support #26834 and when it is merged this section (and the same sections in the Unix and OpenBSD build documents) will need to be updated regardless.
murrayn force-pushed on Jan 14, 2023
murrayn force-pushed on Feb 15, 2023
update the freebsd build doc to reflect recent changes to DB4 install process c572eae989
murrayn force-pushed on Feb 15, 2023
murrayn commented at 9:19 AM on February 15, 2023: contributor

I've updated the document to reflect the removal of install_db4.sh #26834
murrayn renamed this:
~~doc: FreeBSD build doc should suggest db4 for legacy wallet support~~
doc: FreeBSD build doc updates to reflect removal of install_db4.sh
on Feb 15, 2023
fanquake approved
fanquake commented at 10:42 AM on February 16, 2023: member

ACK c572eae9891476a2fab263b3aa82ed27c17a9225 - have not tested, but looks ok.
fanquake merged this on Feb 16, 2023
fanquake closed this on Feb 16, 2023
sidhujag referenced this in commit 2805e9f539 on Feb 16, 2023
murrayn deleted the branch on Feb 17, 2023
bitcoin deleted a comment on Jan 24, 2024
bitcoin locked this on Jan 23, 2025

Type	Reviewers
ACK	fanquake

Contributors

Labels

Linked (view graph)

#26834 contrib: remove install_db4.sh

doc: FreeBSD build doc updates to reflect removal of install_db4.sh #26773

Reviews