doc: split FreeBSD build instructions out of build-unix.md #13372

pull steverusso wants to merge 1 commits into bitcoin:master from steverusso:link-to-building-on-freebsd changing 2 files +47 −32

steverusso commented at 3:03 AM on June 2, 2018: contributor

I've found that the instructions for how to build on FreeBSD are difficult to find. (They are located at the very bottom of the build-unix.md guide.)

In the beginning of the build-unix.md guide, there is a list for "BSD specific instructions" which has links to the build-netbsd.md and build-openbsd.md guides. I figured that the FreeBSD build instructions should be linked to as well in that list which would make them easier to discover.

(I also think the argument could be made to separate out the FreeBSD build instructions into a build-freebsd.md guide, which I'd be happy to do, but I'll leave that for discussion.)
fanquake added the label Docs on Jun 2, 2018
fanquake commented at 3:16 AM on June 2, 2018: member

We also have netbsd instructions.

You might as well split the FreeBSD instructions into their own file, and then update the sentence in build-unix.md to something like: "For BSD specific instructions, see build-*bsd.md in this directory".
steverusso commented at 3:20 AM on June 2, 2018: contributor

Ok cool. Thank you.
fanquake commented at 5:25 AM on June 2, 2018: member

@steverusso Thanks. Can you please squash your commits. You can use a commit message like "doc: split FreeBSD build instructions out of build-unix.md"

doc: split FreeBSD build instructions out of build-unix.md

docs: Linked to the 'Building on FreeBSD' section of the Unix guide where it lists BSD specific guides.

Created a FreeBSD build guide (doc/build-freebsd.md).

Added in warning about the version of 'gdb' installed by default.

Removed the FreeBSD build instructions now that they have their own guide (doc/build-freebsd.md).

Updated the sentence to refer to the BSD guides in the 'doc' directory for more specific BSD build instructions.

Minor grammatical fix.

1e4eec47be

fanquake commented at 7:21 AM on June 2, 2018: member

tested ACK 1e4eec4 with a FreeBSD 11.1 VM.
MarcoFalke commented at 2:41 PM on June 2, 2018: member

utACK 1e4eec47beb5d910b99f4c062fa4388337106d14
fanquake renamed this:
~~Docs: Linked to 'Building on FreeBSD' in build-unix.md~~
doc: split FreeBSD build instructions out of build-unix.md
on Jun 4, 2018
laanwj commented at 6:03 AM on June 4, 2018: member

I like the idea. At some point we might want to split out the linux specific instructions too, it doesn't make more sense to have those be an inline part than FreeBSD/OpenBSD. One could argue build-unix.md is now "Linux build instructions but not the UNIX ones". anyhow utACK 1e4eec47beb5d910b99f4c062fa4388337106d14
laanwj merged this on Jun 4, 2018
laanwj closed this on Jun 4, 2018
laanwj referenced this in commit f0149330d2 on Jun 4, 2018
steverusso commented at 5:24 PM on June 4, 2018: contributor

I agree, and I'd be happy to help with that if you would like.

But anyway, thanks everyone for guiding me with this. I appreciate all the help!
steverusso deleted the branch on Jun 4, 2018
DrahtBot locked this on Sep 8, 2021

Contributors

Labels