Skip to content

Conversation

jarolrod
Copy link
Member

@jarolrod jarolrod commented Dec 8, 2020

The current FreeBSD Build documentation is a little outdated and underwhelming. This PR intends to keep the build-freebsd.md doc up to date. Here are the main improvements:

  • Introduce dependency information
  • New instructions for building the GUI
  • Instructions for supporting descriptor wallets
  • Various notes on the build and compile process

Before/Master: render

After/PR: render

@DrahtBot DrahtBot added the Docs label Dec 8, 2020
@vasild
Copy link
Contributor

vasild commented Dec 9, 2020

Render: master, this PR.

Copy link
Contributor

@vasild vasild left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent work!

I think it is ok to recommend using db5 from the Ports/packages as installing that is a breeze compared to db4.8 which is not in the Ports/packages.

Some other minor suggestions below.

@DrahtBot
Copy link
Contributor

DrahtBot commented Dec 9, 2020

🕵️ @harding @fanquake have been requested to review this pull request as specified in the REVIEWERS file.

@vasild
Copy link
Contributor

vasild commented Dec 10, 2020

https://travis-ci.org/github/bitcoin/bitcoin/builds/748668149#L457

The subject line of commit hash 6de81d1 is followed by a non-empty line. Subject lines should always be followed by a blank line.

I think it is ok to squash everything in one commit.

The current FreeBSD Build documentation is a little outdated and underwhelming. This PR updates the doc to
be more informative. It also adds new instructions for building the GUI and adding support for  descriptor
wallets.

on vasild's recommendation: it is ok to point the user to download db5 which has an active port package
instead of building db4 from the provided script.

Co-authored-by: Vasil Dimov <vd@freebsd.org>
@laanwj
Copy link
Member

laanwj commented Dec 14, 2020

Seems fine to me.

It does change the document to a different style than the others, e.g. we don't use --- (horizontal separator) after sections anywhere else, but I don't know if that's important.

utACK c175690

@laanwj laanwj merged commit 2d4eeaf into bitcoin:master Dec 16, 2020
sidhujag pushed a commit to syscoin/syscoin that referenced this pull request Dec 17, 2020
fanquake added a commit to bitcoin-core/gui that referenced this pull request Mar 18, 2021
c180c91 doc: revamp macOS build doc (Jarol Rodriguez)

Pull request description:

  This PR makes the macOS build-docs more informative and adds in the following information:
  - Proper descriptions and delineation of required/optional dependencies
  - walk-through of optional dependencies
  - configuration walk-through
  - various other tidbits of information

  This is a part of the efforts done in bitcoin/bitcoin#20601 and bitcoin/bitcoin#20610 to update the docs and introduce some consistency between them.

  This update does not add instructions for arm-based M1 Macbooks as I do not have one to test with. It would be nice to have someone follow up with an update containing instructions for arm-based Macs.

  **Before/Master:** [render](https://github.com/bitcoin/bitcoin/blob/master/doc/build-osx.md)
  **After/PR:** [render](https://github.com/bitcoin/bitcoin/blob/c180c911b88b2bd2baf2c9c2b24e276787ffb69b/doc/build-osx.md)

ACKs for top commit:
  fanquake:
    ACK c180c91 - I still think these are getting too verbose and we're duplicating information all over the place; dependencies, configure options, combinations of options etc. However if people are happy to maintain them, I guess it's fine for now, and this revamping has already happened for some of the other build READMEs.

Tree-SHA512: 1440046c723fe80d4158e4a429e3aa8bd93570acb84ad202d5d24c749ab9a89a3aca8b61b49e75e042a4bf4317acd632d3906e1b5808a9052e74209256528b45
@bitcoin bitcoin locked as resolved and limited conversation to collaborators Feb 15, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants