Browse Source

Merge #10680: Fix inconsistencies and grammar in various files

1d8df0141 Fix MD formatting in REST-interface.md and spelling mistake in test_runner.py (MeshCollider)
41f3e84aa Fix inconsistencies and grammar in various files (MeshCollider)

Pull request description:

  Just a simple fix of some inconsistent capitalization, formatting and grammar in a few files (no code changes)

Tree-SHA512: 60b12a5a5c69a1af4a25b7db0b32ed806ed62ad2966cee08b3792a7cfa7f51848fd485349b4c09e60a7eedfdf55ee730c51daa066d6e226ae404c93342bf3e13
0.16
MarcoFalke 7 years ago
parent
commit
6366941275
No known key found for this signature in database
GPG Key ID: D2EA4850E7528B25
  1. 2
      contrib/README.md
  2. 2
      contrib/bitcoind.bash-completion
  3. 6
      contrib/gitian-build.sh
  4. 2
      contrib/gitian-descriptors/README.md
  5. 2
      contrib/gitian-keys/README.md
  6. 4
      contrib/init/bitcoind.conf
  7. 4
      contrib/init/bitcoind.openrc
  8. 14
      contrib/rpm/README.md
  9. 12
      doc/REST-interface.md
  10. 2
      test/functional/test_runner.py

2
contrib/README.md

@ -35,7 +35,7 @@ PGP keys used for signing Bitcoin Core [Gitian release](/doc/release-process.md)
Scripts and notes for Mac builds. Scripts and notes for Mac builds.
### [RPM](/contrib/rpm) ### ### [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) ### ### [Gitian-build](/contrib/gitian-build.sh) ###
Script for running full Gitian builds. Script for running full Gitian builds.

2
contrib/bitcoind.bash-completion

@ -30,7 +30,7 @@ _bitcoind() {
;; ;;
*) *)
# only parse -help if senseful # only parse -help if sensible
if [[ -z "$cur" || "$cur" =~ ^- ]]; then if [[ -z "$cur" || "$cur" =~ ^- ]]; then
local helpopts local helpopts
helpopts=$($bitcoind -help 2>&1 | awk '$1 ~ /^-/ { sub(/=.*/, "="); print $1 }' ) helpopts=$($bitcoind -help 2>&1 | awk '$1 ~ /^-/ { sub(/=.*/, "="); print $1 }' )

6
contrib/gitian-build.sh

@ -40,15 +40,15 @@ version Version number, commit, or branch to build. If building a commit or bra
Options: Options:
-c|--commit Indicate that the version argument is for a commit or branch -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 -u|--url Specify the URL of the repository. Default is https://github.com/bitcoin/bitcoin
-v|--verify Verify the gitian build -v|--verify Verify the Gitian build
-b|--build Do a gitian build -b|--build Do a Gitian build
-s|--sign Make signed binaries for Windows and Mac OSX -s|--sign Make signed binaries for Windows and Mac OSX
-B|--buildsign Build both signed and unsigned binaries -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 -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 -j Number of processes to use. Default 2
-m Memory to allocate in MiB. Default 2000 -m Memory to allocate in MiB. Default 2000
--kvm Use KVM instead of LXC --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. --detach-sign Create the assert file for detached signing. Will not commit anything.
--no-commit Do not commit anything to git --no-commit Do not commit anything to git
-h|--help Print this help message -h|--help Print this help message

2
contrib/gitian-descriptors/README.md

@ -1,4 +1,4 @@
### Gavin's notes on getting gitian builds up and running using KVM ### Gavin's notes on getting Gitian builds up and running using KVM
These instructions distilled from These instructions distilled from
[https://help.ubuntu.com/community/KVM/Installation](https://help.ubuntu.com/community/KVM/Installation). [https://help.ubuntu.com/community/KVM/Installation](https://help.ubuntu.com/community/KVM/Installation).

2
contrib/gitian-keys/README.md

@ -3,7 +3,7 @@ PGP keys
This folder contains the public keys of developers and active contributors. This folder contains the public keys of developers and active contributors.
The keys are mainly used to sign git commits or the build results of gitian The keys are mainly used to sign git commits or the build results of Gitian
builds. builds.
You can import the keys into gpg as follows. Also, make sure to fetch the You can import the keys into gpg as follows. Also, make sure to fetch the

4
contrib/init/bitcoind.conf

@ -30,12 +30,12 @@ pre-start script
echo echo
echo "This password is security critical to securing wallets " echo "This password is security critical to securing wallets "
echo "and must not be the same as the rpcuser setting." 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 "command from the shell:"
echo echo
echo "bash -c 'tr -dc a-zA-Z0-9 < /dev/urandom | head -c32 && echo'" echo "bash -c 'tr -dc a-zA-Z0-9 < /dev/urandom | head -c32 && echo'"
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 "notified of problems:"
echo echo
echo "ie: alertnotify=echo %%s | mail -s \"Bitcoin Alert\"" \ echo "ie: alertnotify=echo %%s | mail -s \"Bitcoin Alert\"" \

4
contrib/init/bitcoind.openrc

@ -76,12 +76,12 @@ checkconfig()
eerror "" eerror ""
eerror "This password is security critical to securing wallets " eerror "This password is security critical to securing wallets "
eerror "and must not be the same as the rpcuser setting." 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 "command from the shell:"
eerror "" eerror ""
eerror "bash -c 'tr -dc a-zA-Z0-9 < /dev/urandom | head -c32 && echo'" eerror "bash -c 'tr -dc a-zA-Z0-9 < /dev/urandom | head -c32 && echo'"
eerror "" 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 "notified of problems:"
eerror "" eerror ""
eerror "ie: alertnotify=echo %%s | mail -s \"Bitcoin Alert\"" \ eerror "ie: alertnotify=echo %%s | mail -s \"Bitcoin Alert\"" \

14
contrib/rpm/README.md

@ -84,16 +84,16 @@ If you would prefer not to build the GUI at all, you can pass the switch
The desktop and KDE meta files are created in the spec file itself with the 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 `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 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 built. If you do make changes to them, you probably should update timestamp
assigned to them in the `touch` command that specifies the time stamp. assigned to them in the `touch` command that specifies the timestamp.
## SVG, PNG, and XPM Icons ## SVG, PNG, and XPM Icons
The `bitcoin.svg` file is from the source listed as `Source100`. It is used as 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 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. derived from it.
## Systemd ## Systemd
@ -105,10 +105,10 @@ distributions that still receive vendor updates do in fact use systemd.
The files to control the service are created in the RPM spec file itself using 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 the `cat` command. This is done to make it easy to modify for other
distributions that may implement things differently without needing to patch 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 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` them, you probably should update the timestamp assigned to them in the `touch`
command that specifies the time stamp. command that specifies the timestamp.
## SELinux ## SELinux

12
doc/REST-interface.md

@ -8,14 +8,14 @@ The interface runs on the same port as the JSON-RPC interface, by default port 8
Supported API Supported API
------------- -------------
####Transactions #### Transactions
`GET /rest/tx/<TX-HASH>.<bin|hex|json>` `GET /rest/tx/<TX-HASH>.<bin|hex|json>`
Given a transaction hash: returns a transaction in binary, hex-encoded binary, or JSON formats. 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. For full TX query capability, one must enable the transaction index via "txindex=1" command line / configuration option.
####Blocks #### Blocks
`GET /rest/block/<BLOCK-HASH>.<bin|hex|json>` `GET /rest/block/<BLOCK-HASH>.<bin|hex|json>`
`GET /rest/block/notxdetails/<BLOCK-HASH>.<bin|hex|json>` `GET /rest/block/notxdetails/<BLOCK-HASH>.<bin|hex|json>`
@ -25,12 +25,12 @@ The HTTP request and response are both handled entirely in-memory, thus making m
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. 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/<COUNT>/<BLOCK-HASH>.<bin|hex|json>` `GET /rest/headers/<COUNT>/<BLOCK-HASH>.<bin|hex|json>`
Given a block hash: returns <COUNT> amount of blockheaders in upward direction. Given a block hash: returns <COUNT> amount of blockheaders in upward direction.
####Chaininfos #### Chaininfos
`GET /rest/chaininfo.json` `GET /rest/chaininfo.json`
Returns various state info regarding block chain processing. Returns various state info regarding block chain processing.
@ -48,7 +48,7 @@ Only supports JSON as output format.
* softforks : (array) status of softforks in progress * softforks : (array) status of softforks in progress
* bip9_softforks : (object) status of BIP9 softforks in progress * bip9_softforks : (object) status of BIP9 softforks in progress
####Query UTXO set #### Query UTXO set
`GET /rest/getutxos/<checkmempool>/<txid>-<n>/<txid>-<n>/.../<txid>-<n>.<bin|hex|json>` `GET /rest/getutxos/<checkmempool>/<txid>-<n>/<txid>-<n>/.../<txid>-<n>.<bin|hex|json>`
The getutxo command allows querying of the UTXO set given a set of outpoints. The getutxo command allows querying of the UTXO set given a set of outpoints.
@ -81,7 +81,7 @@ $ curl localhost:18332/rest/getutxos/checkmempool/b2cdfd7b89def827ff8af7cd9bff76
} }
``` ```
####Memory pool #### Memory pool
`GET /rest/mempool/info.json` `GET /rest/mempool/info.json`
Returns various information about the TX mempool. Returns various information about the TX mempool.

2
test/functional/test_runner.py

@ -352,7 +352,7 @@ def print_results(test_results, max_len_name, runtime):
class TestHandler: class TestHandler:
""" """
Trigger the testscrips passed in via the list. Trigger the test scripts passed in via the list.
""" """
def __init__(self, num_tests_parallel, tests_dir, tmpdir, test_list=None, flags=None): def __init__(self, num_tests_parallel, tests_dir, tmpdir, test_list=None, flags=None):

Loading…
Cancel
Save