build: Improve build instructions #6933

pull laanwj wants to merge 1 commits into bitcoin:master from laanwj:2015_10_modernize_linux_build_instructions changing 3 files +66 −18

laanwj commented at 10:53 AM on November 3, 2015: member
- Add separate boost package instructions for Ubuntu 15.10
- Clarify BerkeleyDB/wallet situation for unix
- Add basic build instructions for Windows (closes #1401)
[skip ci]
laanwj added the label Docs and Output on Nov 3, 2015
laanwj force-pushed on Nov 3, 2015
laanwj force-pushed on Nov 3, 2015
laanwj force-pushed on Nov 3, 2015
jmcorgan commented at 11:06 AM on November 3, 2015: contributor

The statement about individual package names for Ubuntu is a little unclear. First, you say that for 15.10+ you can do this with individual -dev packages, but then you go on to say that for 12.04+ you have to use the -all-dev. Did I misread?
laanwj commented at 11:10 AM on November 3, 2015: member

Good point, will change that to say pre-15.10.
laanwj force-pushed on Nov 3, 2015
laanwj force-pushed on Nov 3, 2015
laanwj commented at 11:16 AM on November 3, 2015: member

BTW it is probably the same for newer versions of Debian, I just don't know so I kept that the same. Installing libboost-all-dev is a safe fallback.
in doc/build-windows.md:None in ab68dc89a5 outdated
```
  32 | +    make HOST=x86_64-w64-mingw32 -j4
  33 | +    cd ..
  34 | +    ./configure --prefix=`pwd`/depends/x86_64-w64-mingw32
  35 | +    make
  36 | +
  37 | +For further documentation on the depends system see [../depends/README.md](README.md) in the depends directory.
```
MarcoFalke commented at 12:11 PM on November 3, 2015:

Nit: Syntax is wrong. Try [Read](../link)

Unrelated note: You may want to remove the (closes [#1401](/bitcoin-bitcoin/1401/)) from the commit message because GitHub parses this every time this appears in a commit with a different hash (e.g. force push, cherry-pick)
laanwj force-pushed on Nov 3, 2015
in doc/build-windows.md:None in bcbf2d3117 outdated
```
   0 | @@ -0,0 +1,38 @@
   1 | +WINDOWS BUILD NOTES
   2 | +====================
   3 | +
   4 | +Some notes on how to build Bitcoin Core for Windows.
   5 | +
   6 | +Building on Windows itself is possible, but no one documented the steps to do this.
```
jamesob commented at 3:02 PM on November 3, 2015:

Is this necessary to note?

jamesob commented at 3:03 PM on November 3, 2015:

Oh, I see -- since you're only documenting cross-compilation. Nevermind!

laanwj commented at 3:45 PM on November 3, 2015:

Hm, yes, may be better to reverse this paragraph and the next.
jamesob commented at 3:05 PM on November 3, 2015: member

ACK
jonasschnelli commented at 7:23 PM on November 3, 2015: contributor

Text-Review ACK. It would be nice to shuffle Qt4/5 order in the doc/build-unix.md around L106. We should first mention Qt5 and maybe "tag* Qt4 as supported but not optimized for (or something similar).
in doc/build-unix.md:None in bcbf2d3117 outdated
```
  60 | @@ -61,34 +61,40 @@ Dependency Build Instructions: Ubuntu & Debian
  61 |  ----------------------------------------------
  62 |  Build requirements:
  63 |  
  64 | -	sudo apt-get install build-essential libtool autotools-dev autoconf pkg-config libssl-dev libevent-dev
  65 | +        sudo apt-get install build-essential libtool autotools-dev autoconf pkg-config libssl-dev libevent-dev
```
dexX7 commented at 10:29 AM on November 4, 2015:

Nit: these whitespaces are not consistent throughout the document.

Some code parts are wrapped with ```, while others are not, and the number of spaces seems to be different (e.g. "To build": 0, Build requirements" has more than "To build with Qt 4...").

MarcoFalke commented at 10:34 AM on November 4, 2015:

As long as the rendered output looks correct, this doesn't matter too much.

dexX7 commented at 10:38 AM on November 4, 2015:

Well, if only the rendered output matters, then I suggest to use plain ``` around code parts, without spaces.

But it actually doesn't look correct: "To build" isn't indented, while "Build requirements" is [...].

Here's an example from another part:

laanwj commented at 10:43 AM on November 4, 2015:

Not going to worry about spaces too much here, sorry. Let's focus on technical content.

MarcoFalke commented at 10:46 AM on November 4, 2015:

@dexX7 I see, now. 4 Spaces or one tab are enough in the source markdown.
dexX7 commented at 10:51 AM on November 4, 2015:

@MarcoFalke: right.

So either: [4 spaces][code]

Or:

[code]

@laanwj: content itself looks good to me!
laanwj commented at 10:43 AM on November 4, 2015: member

It would be nice to shuffle Qt4/5 order in the doc/build-unix.md around L106. We should first mention Qt5 and maybe "tag* Qt4 as supported but not optimized for (or something similar).

Yes, good idea.

build: Improve build instructions

- Add package instructions for Ubuntu 15.10
- Clarify BerkeleyDB/wallet situation for unix
- Add basic build instructions for Windows (closes #1401)

35bb381435

laanwj force-pushed on Nov 4, 2015
laanwj merged this on Nov 4, 2015
laanwj closed this on Nov 4, 2015
laanwj referenced this in commit 29c3c43e19 on Nov 4, 2015
DrahtBot locked this on Sep 8, 2021

Contributors

Labels

Linked (view graph)

#1401 windows build instructions don't work