diff --git a/contrib/README.md b/contrib/README.md --- a/contrib/README.md +++ b/contrib/README.md @@ -35,7 +35,7 @@ Scripts and notes for Mac builds. ### [RPM](/contrib/rpm) ### -RPM spec file for building bitcoin-core on RPM based distributions +RPM spec file for building bitcoin-core on RPM based distributions. ### [Gitian-build](/contrib/gitian-build.sh) ### Script for running full Gitian builds. diff --git a/contrib/bitcoin-cli.bash-completion b/contrib/bitcoin-cli.bash-completion --- a/contrib/bitcoin-cli.bash-completion +++ b/contrib/bitcoin-cli.bash-completion @@ -123,12 +123,12 @@ *) local helpopts commands - # only parse -help if senseful + # only parse -help if sensible if [[ -z "$cur" || "$cur" =~ ^- ]]; then helpopts=$($bitcoin_cli -help 2>&1 | awk '$1 ~ /^-/ { sub(/=.*/, "="); print $1 }' ) fi - # only parse help if senseful + # only parse help if sensible if [[ -z "$cur" || "$cur" =~ ^[a-z] ]]; then commands=$(_bitcoin_rpc help 2>/dev/null | awk '$1 ~ /^[a-z]/ { print $1; }') fi diff --git a/contrib/bitcoind.bash-completion b/contrib/bitcoind.bash-completion --- a/contrib/bitcoind.bash-completion +++ b/contrib/bitcoind.bash-completion @@ -30,7 +30,7 @@ ;; *) - # only parse -help if senseful + # only parse -help if sensible if [[ -z "$cur" || "$cur" =~ ^- ]]; then local helpopts helpopts=$($bitcoind -help 2>&1 | awk '$1 ~ /^-/ { sub(/=.*/, "="); print $1 }' ) diff --git a/contrib/gitian/gitian-build.sh b/contrib/gitian/gitian-build.sh --- a/contrib/gitian/gitian-build.sh +++ b/contrib/gitian/gitian-build.sh @@ -40,15 +40,15 @@ Options: -c|--commit Indicate that the version argument is for a commit or branch -u|--url Specify the URL of the repository. Default is https://github.com/bitcoin/bitcoin --v|--verify Verify the gitian build --b|--build Do a gitian build +-v|--verify Verify the Gitian build +-b|--build Do a Gitian build -s|--sign Make signed binaries for Windows and Mac OSX -B|--buildsign Build both signed and unsigned binaries -o|--os Specify which Operating Systems the build is for. Default is lwx. l for linux, w for windows, x for osx -j Number of processes to use. Default 2 -m Memory to allocate in MiB. Default 2000 --kvm Use KVM instead of LXC ---setup Setup the gitian building environment. Uses KVM. If you want to use lxc, use the --lxc option. Only works on Debian-based systems (Ubuntu, Debian) +--setup Set up the Gitian building environment. Uses KVM. If you want to use lxc, use the --lxc option. Only works on Debian-based systems (Ubuntu, Debian) --detach-sign Create the assert file for detached signing. Will not commit anything. --no-commit Do not commit anything to git -h|--help Print this help message diff --git a/contrib/init/bitcoind.conf b/contrib/init/bitcoind.conf --- a/contrib/init/bitcoind.conf +++ b/contrib/init/bitcoind.conf @@ -30,12 +30,12 @@ echo echo "This password is security critical to securing wallets " echo "and must not be the same as the rpcuser setting." - echo "You can generate a suitable random password using the following" + echo "You can generate a suitable random password using the following " echo "command from the shell:" echo echo "bash -c 'tr -dc a-zA-Z0-9 < /dev/urandom | head -c32 && echo'" echo - echo "It is also recommended that you also set alertnotify so you are " + echo "It is recommended that you also set alertnotify so you are " echo "notified of problems:" echo echo "ie: alertnotify=echo %%s | mail -s \"Bitcoin Alert\"" \ diff --git a/contrib/init/bitcoind.openrc b/contrib/init/bitcoind.openrc --- a/contrib/init/bitcoind.openrc +++ b/contrib/init/bitcoind.openrc @@ -76,12 +76,12 @@ eerror "" eerror "This password is security critical to securing wallets " eerror "and must not be the same as the rpcuser setting." - eerror "You can generate a suitable random password using the following" + eerror "You can generate a suitable random password using the following " eerror "command from the shell:" eerror "" eerror "bash -c 'tr -dc a-zA-Z0-9 < /dev/urandom | head -c32 && echo'" eerror "" - eerror "It is also recommended that you also set alertnotify so you are " + eerror "It is recommended that you also set alertnotify so you are " eerror "notified of problems:" eerror "" eerror "ie: alertnotify=echo %%s | mail -s \"Bitcoin Alert\"" \ diff --git a/contrib/rpm/README.md b/contrib/rpm/README.md --- a/contrib/rpm/README.md +++ b/contrib/rpm/README.md @@ -84,16 +84,16 @@ The desktop and KDE meta files are created in the spec file itself with the `cat` command. This is done to allow easy distribution specific changes without -needing to use any patches. A specific time stamp is given to the files so that +needing to use any patches. A specific timestamp is given to the files so that it does not they do not appear to have been updated every time the package is -built. If you do make changes to them, you probably should update time stamp -assigned to them in the `touch` command that specifies the time stamp. +built. If you do make changes to them, you probably should update timestamp +assigned to them in the `touch` command that specifies the timestamp. ## SVG, PNG, and XPM Icons The `bitcoin.svg` file is from the source listed as `Source100`. It is used as the source for the PNG and XPM files. The generated PNG and XPM files are given -the same time stamp as the source SVG file as a means of indicating they are +the same timestamp as the source SVG file as a means of indicating they are derived from it. ## Systemd @@ -105,10 +105,10 @@ The files to control the service are created in the RPM spec file itself using the `cat` command. This is done to make it easy to modify for other distributions that may implement things differently without needing to patch -source. A specific time stamp is given to the files so that they do not appear +source. A specific timestamp is given to the files so that they do not appear to have been updated every time the package is built. If you do make changes to -them, you probably should update the time stamp assigned to them in the `touch` -command that specifies the time stamp. +them, you probably should update the timestamp assigned to them in the `touch` +command that specifies the timestamp. ## SELinux diff --git a/doc/REST-interface.md b/doc/REST-interface.md --- a/doc/REST-interface.md +++ b/doc/REST-interface.md @@ -8,14 +8,14 @@ Supported API ------------- -####Transactions +#### Transactions `GET /rest/tx/.` Given a transaction hash: returns a transaction in binary, hex-encoded binary, or JSON formats. For full TX query capability, one must enable the transaction index via "txindex=1" command line / configuration option. -####Blocks +#### Blocks `GET /rest/block/.` `GET /rest/block/notxdetails/.` @@ -25,12 +25,12 @@ With the /notxdetails/ option JSON response will only contain the transaction hash instead of the complete transaction details. The option only affects the JSON response. -####Blockheaders +#### Blockheaders `GET /rest/headers//.` Given a block hash: returns amount of blockheaders in upward direction. -####Chaininfos +#### Chaininfos `GET /rest/chaininfo.json` Returns various state info regarding block chain processing. @@ -46,7 +46,7 @@ * pruneheight : (numeric) highest block available * softforks : (array) status of softforks in progress -####Query UTXO set +#### Query UTXO set `GET /rest/getutxos//-/-/.../-.` The getutxo command allows querying of the UTXO set given a set of outpoints. @@ -79,7 +79,7 @@ } ``` -####Memory pool +#### Memory pool `GET /rest/mempool/info.json` Returns various information about the TX mempool. diff --git a/doc/gitian-signing.md b/doc/gitian-signing.md --- a/doc/gitian-signing.md +++ b/doc/gitian-signing.md @@ -1,33 +1,33 @@ # Gitian signing Once you've followed the instructions in gitian-building.md and verified that -you have the same hashes as other developers, it's time to sign the gitian +you have the same hashes as other developers, it's time to sign the Gitian builds. ## PGP fingerprints of gitian build signers The `contrib/gitian-signing/keys.txt` file contains the PGP fingerprints of -gitian build signers. If you plan on signing gitian builds on a regular basis, +Gitian build signers. If you plan on signing Gitian builds on a regular basis, please add you fingerprint here. TODO: Add reference to gitian keys process instructions once that document is written. It should be clear to signers that there are expectations associated with the siginging process and that it's unacceptable to blindly sign builds. -## Sign your gitian builds +## Sign your Gitian builds -### Sign your gitian builds individually +### Sign your Gitian builds individually TODO: Add scripts and instructions for checking for revoked keys and signing builds. For now, refer to `contrib/check-keys.sh` for retrieving all signing keys. -### Sign your gitian builds under a single SHA256SUMS file (optional) +### Sign your Gitian builds under a single SHA256SUMS file (optional) These steps are optional, but makes sharing the build signatures easier. 1. After building all binaries using gitian, collect the hashes for the builds you care to sign. Exclude any debug binaries, unsigned builds, or metadata - files that are built as part of the gitian process, but be sure to include + files that are built as part of the Gitian process, but be sure to include the source used to generate the binaries. These hashes will look something like this: