diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Doxyfile | 2 | ||||
| -rw-r--r-- | doc/build-unix.md | 8 | ||||
| -rw-r--r-- | doc/build-windows.md | 66 | ||||
| -rw-r--r-- | doc/developer-notes.md | 31 | ||||
| -rw-r--r-- | doc/release-notes.md | 6 |
5 files changed, 87 insertions, 26 deletions
diff --git a/doc/Doxyfile b/doc/Doxyfile index a0cbf7139..ef55acdbc 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8 # title of most generated pages and in a few other places. # The default value is: My Project. -PROJECT_NAME = Bitcoin +PROJECT_NAME = "Bitcoin Core" # The PROJECT_NUMBER tag can be used to enter a project or revision number. This # could be handy for archiving the generated documentation or if some version diff --git a/doc/build-unix.md b/doc/build-unix.md index ba7b9cd18..5b0a38457 100644 --- a/doc/build-unix.md +++ b/doc/build-unix.md @@ -96,13 +96,13 @@ pass `--with-incompatible-bdb` to configure. See the section "Disable-wallet mode" to build Bitcoin Core without wallet. -Optional: +Optional (see --with-miniupnpc and --enable-upnp-default): - sudo apt-get install libminiupnpc-dev (see --with-miniupnpc and --enable-upnp-default) + sudo apt-get install libminiupnpc-dev -ZMQ dependencies: +ZMQ dependencies (provides ZMQ API 4.x): - sudo apt-get install libzmq3-dev (provides ZMQ API 4.x) + sudo apt-get install libzmq3-dev Dependencies for the GUI: Ubuntu & Debian ----------------------------------------- diff --git a/doc/build-windows.md b/doc/build-windows.md index 044356830..b6a047b9c 100644 --- a/doc/build-windows.md +++ b/doc/build-windows.md @@ -7,16 +7,18 @@ Most developers use cross-compilation from Ubuntu to build executables for Windows. This is also used to build the release binaries. While there are potentially a number of ways to build on Windows (for example using msys / mingw-w64), -using the Windows Subsystem For Linux is the most straight forward. If you are building with -an alternative method, please contribute the instructions here for others who are running versions +using the Windows Subsystem For Linux is the most straightforward. If you are building with +another method, please contribute the instructions here for others who are running versions of Windows that are not compatible with the Windows Subsystem for Linux. -Compiling with the Windows Subsystem For Linux -------------------- +Compiling with Windows Subsystem For Linux +------------------------------------------- -With Windows 10, Microsoft has released a new feature named the -[Windows Subsystem for Linux](https://msdn.microsoft.com/commandline/wsl/about). This feature allows you to run a bash shell directly on Windows in an Ubuntu based -environment. Within this environment you can cross compile for Windows without the need for a separate Linux VM or Server. +With Windows 10, Microsoft has released a new feature named the [Windows +Subsystem for Linux](https://msdn.microsoft.com/commandline/wsl/about). This +feature allows you to run a bash shell directly on Windows in an Ubuntu based +environment. Within this environment you can cross compile for Windows without +the need for a separate Linux VM or Server. This feature is not supported in versions of Windows prior to Windows 10 or on Windows Server SKUs. @@ -37,9 +39,6 @@ To get the bash shell, you must first activate the feature in Windows. * Create a new UNIX user account (this is a separate account from your Windows account) After the bash shell is active, you can follow the instructions below for Windows 64-bit Cross-compilation. -When building dependencies within the 'depends' folder, you may encounter an error building -the protobuf dependency. If this occurs, re-run the command with sudo. This is likely -a bug with the Windows Subsystem for Linux feature and may be fixed with a future update. Cross-compilation ------------------- @@ -48,28 +47,55 @@ These steps can be performed on, for example, an Ubuntu VM. The depends system will also work on other Linux distributions, however the commands for installing the toolchain will be different. -Make sure you install the build requirements mentioned in -[build-unix.md](/doc/build-unix.md). -Then, install the toolchains and curl: +First, install the general dependencies: + + sudo apt-get install build-essential libtool autotools-dev automake pkg-config bsdmainutils curl + +A host toolchain (`build-essential`) is necessary because some dependency +packages (such as `protobuf`) need to build host utilities that are used in the +build process. + +## Building for 64-bit Windows + +To build executables for Windows 64-bit, install the following dependencies: - sudo apt-get install g++-mingw-w64-i686 mingw-w64-i686-dev g++-mingw-w64-x86-64 mingw-w64-x86-64-dev curl + sudo apt-get install g++-mingw-w64-x86-64 mingw-w64-x86-64-dev -To build executables for Windows 32-bit: +Then build using: cd depends - make HOST=i686-w64-mingw32 -j4 + make HOST=x86_64-w64-mingw32 -j4 cd .. ./autogen.sh # not required when building from tarball - ./configure --prefix=`pwd`/depends/i686-w64-mingw32 + CONFIG_SITE=$PWD/depends/x86_64-w64-mingw32/share/config.site ./configure --prefix=/ make -To build executables for Windows 64-bit: +## Building for 32-bit Windows + +To build executables for Windows 32-bit, install the following dependencies: + + sudo apt-get install g++-mingw-w64-i686 mingw-w64-i686-dev + +Then build using: cd depends - make HOST=x86_64-w64-mingw32 -j4 + make HOST=i686-w64-mingw32 -j4 cd .. ./autogen.sh # not required when building from tarball - ./configure --prefix=`pwd`/depends/x86_64-w64-mingw32 + CONFIG_SITE=$PWD/depends/i686-w64-mingw32/share/config.site ./configure --prefix=/ make +## Depends system + For further documentation on the depends system see [README.md](../depends/README.md) in the depends directory. + +Installation +------------- + +After building using the Windows subsystem it can be useful to copy the compiled +executables to a directory on the windows drive in the same directory structure +as they appear in the release `.zip` archive. This can be done in the following +way. This will install to `c:\workspace\bitcoin`, for example: + + make install DESTDIR=/mnt/c/workspace/bitcoin + diff --git a/doc/developer-notes.md b/doc/developer-notes.md index b0794e6d3..ba03579e8 100644 --- a/doc/developer-notes.md +++ b/doc/developer-notes.md @@ -408,6 +408,37 @@ GUI should not interact with the user. That's where View classes come in. The converse also holds: try to not directly access core data structures from Views. +Subtrees +---------- + +Several parts of the repository are subtrees of software maintained elsewhere. + +Some of these are maintained by active developers of Bitcoin Core, in which case changes should probably go +directly upstream without being PRed directly against the project. They will be merged back in the next +subtree merge. + +Others are external projects without a tight relationship with our project. Changes to these should also +be sent upstream but bugfixes may also be prudent to PR against Bitcoin Core so that they can be integrated +quickly. Cosmetic changes should be purely taken upstream. + +There is a tool in contrib/devtools/git-subtree-check.sh to check a subtree directory for consistency with +its upstream repository. + +Current subtrees include: + +- src/leveldb + - Upstream at https://github.com/google/leveldb ; Maintained by Google, but open important PRs to Core to avoid delay + +- src/libsecp256k1 + - Upstream at https://github.com/bitcoin-core/secp256k1/ ; actively maintaned by Core contributors. + +- src/crypto/ctaes + - Upstream at https://github.com/bitcoin-core/ctaes ; actively maintained by Core contributors. + +- src/univalue + - Upstream at https://github.com/jgarzik/univalue ; report important PRs to Core to avoid delay. + + Git and github tips --------------------- diff --git a/doc/release-notes.md b/doc/release-notes.md index f511fee22..fe7f69d1f 100644 --- a/doc/release-notes.md +++ b/doc/release-notes.md @@ -53,11 +53,15 @@ Removal of Priority Estimation - Estimation of "priority" needed for a transaction to be included within a target number of blocks has been removed. The rpc calls are deprecated and will either - return -1 or 1e24 appropriately. The format for fee_estimates.dat has also + return -1 or 1e24 appropriately. The format for `fee_estimates.dat` has also changed to no longer save these priority estimates. It will automatically be converted to the new format which is not readable by prior versions of the software. +- The concept of "priority" transactions is planned to be removed in the next + major version. To prepare for this, the default for the rate limit of priority + transactions (`-limitfreerelay`) has been set to `0` kB/minute. + 0.14.0 Change log ================= |