diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/README.md | 1 | ||||
| -rw-r--r-- | doc/build-netbsd.md | 49 | ||||
| -rw-r--r-- | doc/build-unix.md | 22 | ||||
| -rw-r--r-- | doc/man/bitcoin-cli.1 | 18 | ||||
| -rw-r--r-- | doc/man/bitcoin-qt.1 | 44 | ||||
| -rw-r--r-- | doc/man/bitcoin-tx.1 | 10 | ||||
| -rw-r--r-- | doc/man/bitcoind.1 | 44 | ||||
| -rw-r--r-- | doc/release-notes.md | 67 | ||||
| -rw-r--r-- | doc/release-process.md | 3 |
9 files changed, 154 insertions, 104 deletions
diff --git a/doc/README.md b/doc/README.md index 988019869e..ddb239f60c 100644 --- a/doc/README.md +++ b/doc/README.md @@ -42,6 +42,7 @@ The following are developer notes on how to build Bitcoin on your native platfor - [Unix Build Notes](build-unix.md) - [Windows Build Notes](build-windows.md) - [OpenBSD Build Notes](build-openbsd.md) +- [NetBSD Build Notes](build-netbsd.md) - [Gitian Building Guide](gitian-building.md) Development diff --git a/doc/build-netbsd.md b/doc/build-netbsd.md new file mode 100644 index 0000000000..5bf2d6b59b --- /dev/null +++ b/doc/build-netbsd.md @@ -0,0 +1,49 @@ +NetBSD build guide +====================== +(updated for NetBSD 7.0) + +This guide describes how to build bitcoind and command-line utilities on NetBSD. + +This guide does not contain instructions for building the GUI. + +Preparation +------------- + +You will need the following modules, which can be installed via pkgsrc or pkgin: + +``` +autoconf +automake +boost +db4 +git +gmake +libevent +libtool +python27 +``` + +Download the source code: +``` +git clone https://github.com/bitcoin/bitcoin +``` + +See [dependencies.md](dependencies.md) for a complete overview. + +### Building Bitcoin Core + +**Important**: Use `gmake` (the non-GNU `make` will exit with an error). + +With wallet: +``` +./autogen.sh +./configure CPPFLAGS="-I/usr/pkg/include" LDFLAGS="-L/usr/pkg/lib" BOOST_CPPFLAGS="-I/usr/pkg/include" BOOST_LDFLAGS="-L/usr/pkg/lib" +gmake +``` + +Without wallet: +``` +./autogen.sh +./configure --disable-wallet CPPFLAGS="-I/usr/pkg/include" LDFLAGS="-L/usr/pkg/lib" BOOST_CPPFLAGS="-I/usr/pkg/include" BOOST_LDFLAGS="-L/usr/pkg/lib" +gmake +``` diff --git a/doc/build-unix.md b/doc/build-unix.md index af567cadeb..b823c23e0c 100644 --- a/doc/build-unix.md +++ b/doc/build-unix.md @@ -2,7 +2,8 @@ UNIX BUILD NOTES ==================== Some notes on how to build Bitcoin Core in Unix. -(for OpenBSD specific instructions, see [build-openbsd.md](build-openbsd.md)) +(For BSD specific instructions, see [build-openbsd.md](build-openbsd.md) and/or +[build-netbsd.md](build-netbsd.md)) Note --------------------- @@ -61,8 +62,13 @@ tuned to conserve memory with additional CXXFLAGS: ./configure CXXFLAGS="--param ggc-min-expand=1 --param ggc-min-heapsize=32768" -Dependency Build Instructions: Ubuntu & Debian ----------------------------------------------- + +## Linux Distribution Specific Instructions + +### Ubuntu & Debian + +#### Dependency Build Instructions + Build requirements: sudo apt-get install build-essential libtool autotools-dev automake pkg-config libssl-dev libevent-dev bsdmainutils python3 @@ -104,8 +110,7 @@ ZMQ dependencies (provides ZMQ API 4.x): sudo apt-get install libzmq3-dev -Dependencies for the GUI: Ubuntu & Debian ------------------------------------------ +#### Dependencies for the GUI If you want to build Bitcoin-Qt, make sure that the required packages for Qt development are installed. Either Qt 5 or Qt 4 are necessary to build the GUI. @@ -127,8 +132,11 @@ libqrencode (optional) can be installed with: Once these are installed, they will be found by configure and a bitcoin-qt executable will be built by default. -Dependency Build Instructions: Fedora -------------------------------------- + +### Fedora + +#### Dependency Build Instructions + Build requirements: sudo dnf install gcc-c++ libtool make autoconf automake openssl-devel libevent-devel boost-devel libdb4-devel libdb4-cxx-devel python3 diff --git a/doc/man/bitcoin-cli.1 b/doc/man/bitcoin-cli.1 index 6787638443..168a68cb30 100644 --- a/doc/man/bitcoin-cli.1 +++ b/doc/man/bitcoin-cli.1 @@ -1,9 +1,9 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4. -.TH BITCOIN-CLI "1" "September 2017" "bitcoin-cli v0.15.99.0" "User Commands" +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.3. +.TH BITCOIN-CLI "1" "January 2018" "bitcoin-cli v0.16.99.0" "User Commands" .SH NAME -bitcoin-cli \- manual page for bitcoin-cli v0.15.99.0 +bitcoin-cli \- manual page for bitcoin-cli v0.16.99.0 .SH DESCRIPTION -Bitcoin Core RPC client version v0.15.99.0 +Bitcoin Core RPC client version v0.16.99.0 .SS "Usage:" .TP bitcoin\-cli [options] <command> [params] @@ -25,6 +25,14 @@ Specify configuration file (default: bitcoin.conf) \fB\-datadir=\fR<dir> .IP Specify data directory +.HP +\fB\-getinfo\fR +.IP +Get general information from the remote server. Note that unlike +server\-side RPC calls, the results of \fB\-getinfo\fR is the result of +multiple non\-atomic requests. Some entries in the result may +represent results from different states (e.g. wallet balance may +be as of a different block from the chain state reported) .PP Chain selection options: .HP @@ -88,7 +96,7 @@ Send RPC for non\-default wallet on RPC server (argument is wallet filename in bitcoind directory, required if bitcoind/\-Qt runs with multiple wallets) .SH COPYRIGHT -Copyright (C) 2009-2017 The Bitcoin Core developers +Copyright (C) 2009-2018 The Bitcoin Core developers Please contribute if you find Bitcoin Core useful. Visit <https://bitcoincore.org> for further information about the software. diff --git a/doc/man/bitcoin-qt.1 b/doc/man/bitcoin-qt.1 index ae35d50ac3..a8c55fb0b3 100644 --- a/doc/man/bitcoin-qt.1 +++ b/doc/man/bitcoin-qt.1 @@ -1,9 +1,9 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4. -.TH BITCOIN-QT "1" "September 2017" "bitcoin-qt v0.15.99.0" "User Commands" +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.3. +.TH BITCOIN-QT "1" "January 2018" "bitcoin-qt v0.16.99.0" "User Commands" .SH NAME -bitcoin-qt \- manual page for bitcoin-qt v0.15.99.0 +bitcoin-qt \- manual page for bitcoin-qt v0.16.99.0 .SH DESCRIPTION -Bitcoin Core version v0.15.99.0 (64\-bit) +Bitcoin Core version v0.16.99.0 (64\-bit) Usage: .IP bitcoin\-qt [command\-line options] @@ -32,7 +32,7 @@ block hash) If this block is in the chain assume that it and its ancestors are valid and potentially skip their script verification (0 to verify all, default: -0000000000000000003b9ce759c2a087d52abc4266f8f4ebd6d768b89defa50a, +0000000000000000005214481d2d96f898e3d5416e43359c145944a909d242e0, testnet: 0000000002e9e7b00e1f6dc5123a04aad68dd0f0968d8c7aa45f6640795c37b1) .HP @@ -52,6 +52,11 @@ Set database cache size in megabytes (4 to 16384, default: 450) .IP Imports blocks from external blk000??.dat file on startup .HP +\fB\-debuglogfile=\fR<file> +.IP +Specify location of debug log file: this can be an absolute path or a +path relative to the data directory (default: debug.log) +.HP \fB\-maxorphantx=\fR<n> .IP Keep at most <n> unconnectable transactions in memory (default: 100) @@ -76,7 +81,7 @@ Extra transactions to keep in memory for compact block reconstructions .HP \fB\-par=\fR<n> .IP -Set the number of script verification threads (\fB\-2\fR to 16, 0 = auto, <0 = +Set the number of script verification threads (\fB\-6\fR to 16, 0 = auto, <0 = leave that many cores free, default: 0) .HP \fB\-pid=\fR<file> @@ -117,7 +122,8 @@ Connection options: .HP \fB\-addnode=\fR<ip> .IP -Add a node to connect to and attempt to keep the connection open +Add a node to connect to and attempt to keep the connection open (see +the `addnode` RPC command help for more info) .HP \fB\-banscore=\fR<n> .IP @@ -136,7 +142,8 @@ for IPv6 \fB\-connect=\fR<ip> .IP Connect only to the specified node(s); \fB\-connect\fR=\fI\,0\/\fR disables automatic -connections +connections (the rules for this peer are the same as for +\fB\-addnode\fR) .HP \fB\-discover\fR .IP @@ -258,6 +265,18 @@ Tries to keep outbound traffic under the given target (in MiB per 24h), .PP Wallet options: .HP +\fB\-addresstype\fR +.IP +What type of addresses to use ("legacy", "p2sh\-segwit", or "bech32", +default: "p2sh\-segwit") +.HP +\fB\-changetype\fR +.IP +What type of change to use ("legacy", "p2sh\-segwit", or "bech32"). +Default is same as \fB\-addresstype\fR, except when +\fB\-addresstype\fR=\fI\,p2sh\-segwit\/\fR a native segwit output is used when +sending to a native segwit address) +.HP \fB\-disablewallet\fR .IP Do not load the wallet and disable wallet RPC calls @@ -307,7 +326,7 @@ confirmation on average within n blocks (default: 6) .HP \fB\-walletrbf\fR .IP -Send transactions with full\-RBF opt\-in enabled (default: 0) +Send transactions with full\-RBF opt\-in enabled (RPC only, default: 0) .HP \fB\-upgradewallet\fR .IP @@ -321,6 +340,11 @@ Specify wallet file (within data directory) (default: wallet.dat) .IP Make the wallet broadcast transactions (default: 1) .HP +\fB\-walletdir=\fR<dir> +.IP +Specify directory to hold wallets (default: <datadir>/wallets if it +exists, otherwise <datadir>) +.HP \fB\-walletnotify=\fR<cmd> .IP Execute command when a wallet transaction changes (%s in cmd is replaced @@ -542,7 +566,7 @@ Show splash screen on startup (default: 1) .IP Reset all settings changed in the GUI .SH COPYRIGHT -Copyright (C) 2009-2017 The Bitcoin Core developers +Copyright (C) 2009-2018 The Bitcoin Core developers Please contribute if you find Bitcoin Core useful. Visit <https://bitcoincore.org> for further information about the software. diff --git a/doc/man/bitcoin-tx.1 b/doc/man/bitcoin-tx.1 index 8b72fbde05..8e6994ac07 100644 --- a/doc/man/bitcoin-tx.1 +++ b/doc/man/bitcoin-tx.1 @@ -1,9 +1,9 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4. -.TH BITCOIN-TX "1" "September 2017" "bitcoin-tx v0.15.99.0" "User Commands" +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.3. +.TH BITCOIN-TX "1" "January 2018" "bitcoin-tx v0.16.99.0" "User Commands" .SH NAME -bitcoin-tx \- manual page for bitcoin-tx v0.15.99.0 +bitcoin-tx \- manual page for bitcoin-tx v0.16.99.0 .SH DESCRIPTION -Bitcoin Core bitcoin\-tx utility version v0.15.99.0 +Bitcoin Core bitcoin\-tx utility version v0.16.99.0 .SS "Usage:" .TP bitcoin\-tx [options] <hex\-tx> [commands] @@ -112,7 +112,7 @@ set=NAME:JSON\-STRING .IP Set register NAME to given JSON\-STRING .SH COPYRIGHT -Copyright (C) 2009-2017 The Bitcoin Core developers +Copyright (C) 2009-2018 The Bitcoin Core developers Please contribute if you find Bitcoin Core useful. Visit <https://bitcoincore.org> for further information about the software. diff --git a/doc/man/bitcoind.1 b/doc/man/bitcoind.1 index baf747436f..8728965b2a 100644 --- a/doc/man/bitcoind.1 +++ b/doc/man/bitcoind.1 @@ -1,9 +1,9 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4. -.TH BITCOIND "1" "September 2017" "bitcoind v0.15.99.0" "User Commands" +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.3. +.TH BITCOIND "1" "January 2018" "bitcoind v0.16.99.0" "User Commands" .SH NAME -bitcoind \- manual page for bitcoind v0.15.99.0 +bitcoind \- manual page for bitcoind v0.16.99.0 .SH DESCRIPTION -Bitcoin Core Daemon version v0.15.99.0 +Bitcoin Core Daemon version v0.16.99.0 .SS "Usage:" .TP bitcoind [options] @@ -33,7 +33,7 @@ block hash) If this block is in the chain assume that it and its ancestors are valid and potentially skip their script verification (0 to verify all, default: -0000000000000000003b9ce759c2a087d52abc4266f8f4ebd6d768b89defa50a, +0000000000000000005214481d2d96f898e3d5416e43359c145944a909d242e0, testnet: 0000000002e9e7b00e1f6dc5123a04aad68dd0f0968d8c7aa45f6640795c37b1) .HP @@ -57,6 +57,11 @@ Set database cache size in megabytes (4 to 16384, default: 450) .IP Imports blocks from external blk000??.dat file on startup .HP +\fB\-debuglogfile=\fR<file> +.IP +Specify location of debug log file: this can be an absolute path or a +path relative to the data directory (default: debug.log) +.HP \fB\-maxorphantx=\fR<n> .IP Keep at most <n> unconnectable transactions in memory (default: 100) @@ -81,7 +86,7 @@ Extra transactions to keep in memory for compact block reconstructions .HP \fB\-par=\fR<n> .IP -Set the number of script verification threads (\fB\-2\fR to 16, 0 = auto, <0 = +Set the number of script verification threads (\fB\-6\fR to 16, 0 = auto, <0 = leave that many cores free, default: 0) .HP \fB\-pid=\fR<file> @@ -122,7 +127,8 @@ Connection options: .HP \fB\-addnode=\fR<ip> .IP -Add a node to connect to and attempt to keep the connection open +Add a node to connect to and attempt to keep the connection open (see +the `addnode` RPC command help for more info) .HP \fB\-banscore=\fR<n> .IP @@ -141,7 +147,8 @@ for IPv6 \fB\-connect=\fR<ip> .IP Connect only to the specified node(s); \fB\-connect\fR=\fI\,0\/\fR disables automatic -connections +connections (the rules for this peer are the same as for +\fB\-addnode\fR) .HP \fB\-discover\fR .IP @@ -263,6 +270,18 @@ Tries to keep outbound traffic under the given target (in MiB per 24h), .PP Wallet options: .HP +\fB\-addresstype\fR +.IP +What type of addresses to use ("legacy", "p2sh\-segwit", or "bech32", +default: "p2sh\-segwit") +.HP +\fB\-changetype\fR +.IP +What type of change to use ("legacy", "p2sh\-segwit", or "bech32"). +Default is same as \fB\-addresstype\fR, except when +\fB\-addresstype\fR=\fI\,p2sh\-segwit\/\fR a native segwit output is used when +sending to a native segwit address) +.HP \fB\-disablewallet\fR .IP Do not load the wallet and disable wallet RPC calls @@ -312,7 +331,7 @@ confirmation on average within n blocks (default: 6) .HP \fB\-walletrbf\fR .IP -Send transactions with full\-RBF opt\-in enabled (default: 0) +Send transactions with full\-RBF opt\-in enabled (RPC only, default: 0) .HP \fB\-upgradewallet\fR .IP @@ -326,6 +345,11 @@ Specify wallet file (within data directory) (default: wallet.dat) .IP Make the wallet broadcast transactions (default: 1) .HP +\fB\-walletdir=\fR<dir> +.IP +Specify directory to hold wallets (default: <datadir>/wallets if it +exists, otherwise <datadir>) +.HP \fB\-walletnotify=\fR<cmd> .IP Execute command when a wallet transaction changes (%s in cmd is replaced @@ -521,7 +545,7 @@ non\-verbose mode, non\-segwit(0) or segwit(1) (default: 1) .IP Set the number of threads to service RPC calls (default: 4) .SH COPYRIGHT -Copyright (C) 2009-2017 The Bitcoin Core developers +Copyright (C) 2009-2018 The Bitcoin Core developers Please contribute if you find Bitcoin Core useful. Visit <https://bitcoincore.org> for further information about the software. diff --git a/doc/release-notes.md b/doc/release-notes.md index 29377d4a1d..0292eaa4d2 100644 --- a/doc/release-notes.md +++ b/doc/release-notes.md @@ -3,7 +3,7 @@ release-notes at release time) Bitcoin Core version *version* is now available from: - <https://bitcoin.org/bin/bitcoin-core-*version*/> + <https://bitcoincore.org/bin/bitcoin-core-*version*/> This is a new major version release, including new features, various bugfixes and performance improvements, as well as updated translations. @@ -56,71 +56,6 @@ frequently tested on them. Notable changes =============== -GCC 4.8.x --------------- -The minimum version of GCC required to compile Bitcoin Core is now 4.8. No effort will be -made to support older versions of GCC. See discussion in issue #11732 for more information. - -HD-wallets by default ---------------------- -Due to a backward-incompatible change in the wallet database, wallets created -with version 0.16.0 will be rejected by previous versions. Also, version 0.16.0 -will only create hierarchical deterministic (HD) wallets. - -Replace-By-Fee by default in GUI --------------------------------- -The send screen now uses BIP-125 RBF by default, regardless of `-walletrbf`. -There is a checkbox to mark the transaction as final. - -The RPC default remains unchanged: to use RBF, launch with `-walletrbf=1` or -use the `replaceable` argument for individual transactions. - -Wallets directory configuration (`-walletdir`) ----------------------------------------------- - -Bitcoin Core now has more flexibility in where the wallets directory can be -located. Previously wallet database files were stored at the top level of the -bitcoin data directory. The behavior is now: - -- For new installations (where the data directory doesn't already exist), - wallets will now be stored in a new `wallets/` subdirectory inside the data - directory by default. -- For existing nodes (where the data directory already exists), wallets will be - stored in the data directory root by default. If a `wallets/` subdirectory - already exists in the data directory root, then wallets will be stored in the - `wallets/` subdirectory by default. -- The location of the wallets directory can be overridden by specifying a - `-walletdir=<path>` option where `<path>` can be an absolute path to a - directory or directory symlink. - -Care should be taken when choosing the wallets directory location, as if it -becomes unavailable during operation, funds may be lost. - -Low-level RPC changes ----------------------- -- The deprecated RPC `getinfo` was removed. It is recommended that the more specific RPCs are used: - * `getblockchaininfo` - * `getnetworkinfo` - * `getwalletinfo` - * `getmininginfo` -- The wallet RPC `getreceivedbyaddress` will return an error if called with an address not in the wallet. -- The wallet RPC `addwitnessaddress` was deprecated and will be removed in version 0.17, - set the `address_type` argument of `getnewaddress`, or option `-addresstype=[bech32|p2sh-segwit]` instead. - -Changed command-line options ------------------------------ -- `-debuglogfile=<file>` can be used to specify an alternative debug logging file. - -Renamed script for creating JSON-RPC credentials ------------------------------ -The `share/rpcuser/rpcuser.py` script was renamed to `share/rpcauth/rpcauth.py`. This script can be -used to create `rpcauth` credentials for a JSON-RPC user. - - -- `dumpwallet` now includes hex-encoded scripts from the wallet in the dumpfile, and - `importwallet` now imports these scripts, but corresponding addresses may not be added - correctly or a manual rescan may be required to find relevant transactions. - Credits ======= diff --git a/doc/release-process.md b/doc/release-process.md index 219bb18600..18ff48ea4e 100644 --- a/doc/release-process.md +++ b/doc/release-process.md @@ -23,7 +23,8 @@ Before every major release: * Update hardcoded [seeds](/contrib/seeds/README.md), see [this pull request](https://github.com/bitcoin/bitcoin/pull/7415) for an example. * Update [`BLOCK_CHAIN_SIZE`](/src/qt/intro.cpp) to the current size plus some overhead. -* Update `src/chainparams.cpp` chainTxData with statistics about the transaction count and rate. +* Update `src/chainparams.cpp` chainTxData with statistics about the transaction count and rate. Use the output of the RPC `getchaintxstats`, see + [this pull request](https://github.com/bitcoin/bitcoin/pull/12270) for an example. * Update version of `contrib/gitian-descriptors/*.yml`: usually one'd want to do this on master after branching off the release - but be sure to at least do it before a new major release ### First time / New builders |