Skip to content

Commit 1ef57a9

Browse files
author
MarcoFalke
committed
Merge #13255: trivial: Fixed typos and cleaned up language
d5f745a trivial: correct typos (Varunram) 3be70ba trivial: Fixed typos and cleaned up language (William Robinson) Pull request description: This rebases and fixes some of the outstanding nits in #13010. Let either merge quickly or close for now. Tree-SHA512: 4cc1a5f854f2d6a19332334e2608a19e2be6b97dc09114c8186237ea77ee4b62372ebf6841a61cca548cedb47f0e6f11d4c0aba51a71949cd5aff8cef88204d6
2 parents 489b51b + d5f745a commit 1ef57a9

File tree

11 files changed

+48
-48
lines changed

11 files changed

+48
-48
lines changed

doc/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ To download Bitcoin Core, visit [bitcoincore.org](https://bitcoincore.org/en/rel
99

1010
Running
1111
---------------------
12-
The following are some helpful notes on how to run Bitcoin on your native platform.
12+
The following are some helpful notes on how to run Bitcoin Core on your native platform.
1313

1414
### Unix
1515

@@ -24,7 +24,7 @@ Unpack the files into a directory, and then run bitcoin-qt.exe.
2424

2525
### macOS
2626

27-
Drag Bitcoin-Core to your applications folder, and then run Bitcoin-Core.
27+
Drag Bitcoin Core to your applications folder, and then run Bitcoin Core.
2828

2929
### Need Help?
3030

@@ -35,7 +35,7 @@ for help and more information.
3535

3636
Building
3737
---------------------
38-
The following are developer notes on how to build Bitcoin on your native platform. They are not complete guides, but include notes on the necessary libraries, compile flags, etc.
38+
The following are developer notes on how to build Bitcoin Core on your native platform. They are not complete guides, but include notes on the necessary libraries, compile flags, etc.
3939

4040
- [Dependencies](dependencies.md)
4141
- [macOS Build Notes](build-osx.md)

doc/benchmarking.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Benchmarking
22
============
33

44
Bitcoin Core has an internal benchmarking framework, with benchmarks
5-
for cryptographic algorithms such as SHA1, SHA256, SHA512 and RIPEMD160. As well as the rolling bloom filter.
5+
for cryptographic algorithms (e.g. SHA1, SHA256, SHA512, RIPEMD160), as well as the rolling bloom filter.
66

77
Running
88
---------------------

doc/bips.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ BIPs that are implemented by Bitcoin Core (up-to-date up to **v0.17.0**):
1313
* [`BIP 32`](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki): Hierarchical Deterministic Wallets has been implemented since **v0.13.0** ([PR #8035](https://github.com/bitcoin/bitcoin/pull/8035)).
1414
* [`BIP 34`](https://github.com/bitcoin/bips/blob/master/bip-0034.mediawiki): The rule that requires blocks to contain their height (number) in the coinbase input, and the introduction of version 2 blocks has been implemented since **v0.7.0**. The rule took effect for version 2 blocks as of *block 224413* (March 5th 2013), and version 1 blocks are no longer allowed since *block 227931* (March 25th 2013) ([PR #1526](https://github.com/bitcoin/bitcoin/pull/1526)).
1515
* [`BIP 35`](https://github.com/bitcoin/bips/blob/master/bip-0035.mediawiki): The 'mempool' protocol message (and the protocol version bump to 60002) has been implemented since **v0.7.0** ([PR #1641](https://github.com/bitcoin/bitcoin/pull/1641)).
16-
* [`BIP 37`](https://github.com/bitcoin/bips/blob/master/bip-0037.mediawiki): The bloom filtering for transaction relaying, partial merkle trees for blocks, and the protocol version bump to 70001 (enabling low-bandwidth SPV clients) has been implemented since **v0.8.0** ([PR #1795](https://github.com/bitcoin/bitcoin/pull/1795)).
16+
* [`BIP 37`](https://github.com/bitcoin/bips/blob/master/bip-0037.mediawiki): The bloom filtering for transaction relaying, partial Merkle trees for blocks, and the protocol version bump to 70001 (enabling low-bandwidth SPV clients) has been implemented since **v0.8.0** ([PR #1795](https://github.com/bitcoin/bitcoin/pull/1795)).
1717
* [`BIP 42`](https://github.com/bitcoin/bips/blob/master/bip-0042.mediawiki): The bug that would have caused the subsidy schedule to resume after block 13440000 was fixed in **v0.9.2** ([PR #3842](https://github.com/bitcoin/bitcoin/pull/3842)).
1818
* [`BIP 61`](https://github.com/bitcoin/bips/blob/master/bip-0061.mediawiki): The 'reject' protocol message (and the protocol version bump to 70002) was added in **v0.9.0** ([PR #3185](https://github.com/bitcoin/bitcoin/pull/3185)). Starting *v0.17.0*, whether to send reject messages can be configured with the `-enablebip61` option.
1919
* [`BIP 65`](https://github.com/bitcoin/bips/blob/master/bip-0065.mediawiki): The CHECKLOCKTIMEVERIFY softfork was merged in **v0.12.0** ([PR #6351](https://github.com/bitcoin/bitcoin/pull/6351)), and backported to **v0.11.2** and **v0.10.4**. Mempool-only CLTV was added in [PR #6124](https://github.com/bitcoin/bitcoin/pull/6124).

doc/build-osx.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,14 +41,14 @@ from the root of the repository.
4141
Build Bitcoin Core
4242
------------------------
4343

44-
1. Clone the bitcoin source code and cd into `bitcoin`
44+
1. Clone the Bitcoin Core source code and cd into `bitcoin`
4545

4646
git clone https://github.com/bitcoin/bitcoin
4747
cd bitcoin
4848

49-
2. Build bitcoin-core:
49+
2. Build Bitcoin Core:
5050

51-
Configure and build the headless bitcoin binaries as well as the GUI (if Qt is found).
51+
Configure and build the headless Bitcoin Core binaries as well as the GUI (if Qt is found).
5252

5353
You can disable the GUI build by passing `--without-gui` to configure.
5454

@@ -69,7 +69,7 @@ Running
6969

7070
Bitcoin Core is now available at `./src/bitcoind`
7171

72-
Before running, it's recommended you create an RPC configuration file.
72+
Before running, it's recommended that you create an RPC configuration file.
7373

7474
echo -e "rpcuser=bitcoinrpc\nrpcpassword=$(xxd -l 16 -p /dev/urandom)" > "/Users/${USER}/Library/Application Support/Bitcoin/bitcoin.conf"
7575

doc/build-unix.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Some notes on how to build Bitcoin Core in Unix.
66

77
Note
88
---------------------
9-
Always use absolute paths to configure and compile bitcoin and the dependencies,
9+
Always use absolute paths to configure and compile Bitcoin Core and the dependencies,
1010
for example, when specifying the path of the dependency:
1111

1212
../dist/configure --enable-cxx --disable-shared --with-pic --prefix=$BDB_PREFIX
@@ -99,7 +99,7 @@ ZMQ dependencies (provides ZMQ API 4.x):
9999

100100
#### Dependencies for the GUI
101101

102-
If you want to build Bitcoin-Qt, make sure that the required packages for Qt development
102+
If you want to build bitcoin-qt, make sure that the required packages for Qt development
103103
are installed. Qt 5 is necessary to build the GUI.
104104
To build without GUI pass `--without-gui`.
105105

@@ -178,7 +178,7 @@ If you need to build Boost yourself:
178178

179179
Security
180180
--------
181-
To help make your bitcoin installation more secure by making certain attacks impossible to
181+
To help make your Bitcoin Core installation more secure by making certain attacks impossible to
182182
exploit even if a vulnerability is found, binaries are hardened by default.
183183
This can be disabled with:
184184

@@ -194,7 +194,7 @@ Hardening enables the following features:
194194
Build position independent code to take advantage of Address Space Layout Randomization
195195
offered by some kernels. Attackers who can cause execution of code at an arbitrary memory
196196
location are thwarted if they don't know where anything useful is located.
197-
The stack and heap are randomly located by default but this allows the code section to be
197+
The stack and heap are randomly located by default, but this allows the code section to be
198198
randomly located as well.
199199

200200
On an AMD64 processor where a library was not compiled with -fPIC, this will cause an error
@@ -210,24 +210,24 @@ Hardening enables the following features:
210210
ET_DYN
211211

212212
* Non-executable Stack
213-
If the stack is executable then trivial stack based buffer overflow exploits are possible if
214-
vulnerable buffers are found. By default, bitcoin should be built with a non-executable stack
213+
If the stack is executable then trivial stack-based buffer overflow exploits are possible if
214+
vulnerable buffers are found. By default, Bitcoin Core should be built with a non-executable stack,
215215
but if one of the libraries it uses asks for an executable stack or someone makes a mistake
216216
and uses a compiler extension which requires an executable stack, it will silently build an
217217
executable without the non-executable stack protection.
218218

219219
To verify that the stack is non-executable after compiling use:
220220
`scanelf -e ./bitcoin`
221221

222-
the output should contain:
222+
The output should contain:
223223
STK/REL/PTL
224224
RW- R-- RW-
225225

226226
The STK RW- means that the stack is readable and writeable but not executable.
227227

228228
Disable-wallet mode
229229
--------------------
230-
When the intention is to run only a P2P node without a wallet, bitcoin may be compiled in
230+
When the intention is to run only a P2P node without a wallet, Bitcoin Core may be compiled in
231231
disable-wallet mode with:
232232

233233
./configure --disable-wallet

doc/build-windows.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ and is the platform used to build the Bitcoin Core Windows release binaries.
1010
* On Windows using [Windows
1111
Subsystem for Linux (WSL)](https://msdn.microsoft.com/commandline/wsl/about) and the Mingw-w64 cross compiler tool chain.
1212

13-
Other options which may work but which have not been extensively tested are (please contribute instructions):
13+
Other options which may work, but which have not been extensively tested are (please contribute instructions):
1414

1515
* On Windows using a POSIX compatibility layer application such as [cygwin](http://www.cygwin.com/) or [msys2](http://www.msys2.org/).
1616
* On Windows using a native compiler tool chain such as [Visual Studio](https://www.visualstudio.com).
@@ -46,7 +46,7 @@ To install WSL on Windows 10 with Fall Creators Update installed (version >= 162
4646

4747
After the bash shell is active, you can follow the instructions below, starting
4848
with the "Cross-compilation" section. Compiling the 64-bit version is
49-
recommended but it is possible to compile the 32-bit version.
49+
recommended, but it is possible to compile the 32-bit version.
5050

5151
Cross-compilation for Ubuntu and Windows Subsystem for Linux
5252
------------------------------------------------------------
@@ -77,7 +77,7 @@ Ubuntu Bionic 18.04 <sup>[1](#footnote1)</sup>:
7777

7878
sudo update-alternatives --config x86_64-w64-mingw32-g++ # Set the default mingw32 g++ compiler option to posix.
7979

80-
Once the tool chain is installed the build steps are common:
80+
Once the toolchain is installed the build steps are common:
8181

8282
Note that for WSL the Bitcoin Core source path MUST be somewhere in the default mount file system, for
8383
example /usr/src/bitcoin, AND not under /mnt/d/. If this is not the case the dependency autoconf scripts will fail.
@@ -146,5 +146,5 @@ Footnotes
146146
compiler options to allow a choice between either posix or win32 threads. The default option is win32 threads which is the more
147147
efficient since it will result in binary code that links directly with the Windows kernel32.lib. Unfortunately, the headers
148148
required to support win32 threads conflict with some of the classes in the C++11 standard library in particular std::mutex.
149-
It's not possible to build the bitcoin code using the win32 version of the Mingw-w64 cross compilers (at least not without
150-
modifying headers in the bitcoin source code).
149+
It's not possible to build the Bitcoin Core code using the win32 version of the Mingw-w64 cross compilers (at least not without
150+
modifying headers in the Bitcoin Core source code).

doc/developer-notes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,7 @@ make cov
247247

248248
**Sanitizers**
249249

250-
Bitcoin can be compiled with various "sanitizers" enabled, which add
250+
Bitcoin Core can be compiled with various "sanitizers" enabled, which add
251251
instrumentation for issues regarding things like memory safety, thread race
252252
conditions, or undefined behavior. This is controlled with the
253253
`--with-sanitizers` configure flag, which should be a comma separated list of

doc/reduce-traffic.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Reduce Traffic
33

44
Some node operators need to deal with bandwidth caps imposed by their ISPs.
55

6-
By default, bitcoin-core allows up to 125 connections to different peers, 8 of
6+
By default, Bitcoin Core allows up to 125 connections to different peers, 8 of
77
which are outbound. You can therefore, have at most 117 inbound connections.
88

99
The default settings can result in relatively significant traffic consumption.

doc/tor.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
# TOR SUPPORT IN BITCOIN
22

3-
It is possible to run Bitcoin as a Tor hidden service, and connect to such services.
3+
It is possible to run Bitcoin Core as a Tor hidden service, and connect to such services.
44

55
The following directions assume you have a Tor proxy running on port 9050. Many distributions default to having a SOCKS proxy listening on port 9050, but others may not. In particular, the Tor Browser Bundle defaults to listening on port 9150. See [Tor Project FAQ:TBBSocksPort](https://www.torproject.org/docs/faq.html.en#TBBSocksPort) for how to properly
66
configure Tor.
77

88

9-
## 1. Run bitcoin behind a Tor proxy
9+
## 1. Run Bitcoin Core behind a Tor proxy
1010

11-
The first step is running Bitcoin behind a Tor proxy. This will already make all
12-
outgoing connections be anonymized, but more is possible.
11+
The first step is running Bitcoin Core behind a Tor proxy. This will already anonymize all
12+
outgoing connections, but more is possible.
1313

1414
-proxy=ip:port Set the proxy server. If SOCKS5 is selected (default), this proxy
1515
server will be used to try to reach .onion addresses as well.
1616

17-
-onion=ip:port Set the proxy server to use for tor hidden services. You do not
17+
-onion=ip:port Set the proxy server to use for Tor hidden services. You do not
1818
need to set this if it's the same as -proxy. You can use -noonion
1919
to explicitly disable access to hidden service.
2020

@@ -32,7 +32,7 @@ In a typical situation, this suffices to run behind a Tor proxy:
3232
./bitcoind -proxy=127.0.0.1:9050
3333

3434

35-
## 2. Run a bitcoin hidden server
35+
## 2. Run a Bitcoin Core hidden server
3636

3737
If you configure your Tor system accordingly, it is possible to make your node also
3838
reachable from the Tor network. Add these lines to your /etc/tor/torrc (or equivalent
@@ -48,11 +48,11 @@ your bitcoind's P2P listen port (8333 by default).
4848

4949
-externalip=X You can tell bitcoin about its publicly reachable address using
5050
this option, and this can be a .onion address. Given the above
51-
configuration, you can find your onion address in
52-
/var/lib/tor/bitcoin-service/hostname. Onion addresses are given
53-
preference for your node to advertise itself with, for connections
51+
configuration, you can find your .onion address in
52+
/var/lib/tor/bitcoin-service/hostname. For connections
5453
coming from unroutable addresses (such as 127.0.0.1, where the
55-
Tor proxy typically runs).
54+
Tor proxy typically runs), .onion addresses are given
55+
preference for your node to advertise itself with.
5656

5757
-listen You'll need to enable listening for incoming connections, as this
5858
is off by default behind a proxy.
@@ -68,7 +68,7 @@ In a typical situation, where you're only reachable via Tor, this should suffice
6868

6969
./bitcoind -proxy=127.0.0.1:9050 -externalip=57qr3yd1nyntf5k.onion -listen
7070

71-
(obviously, replace the Onion address with your own). It should be noted that you still
71+
(obviously, replace the .onion address with your own). It should be noted that you still
7272
listen on all devices and another node could establish a clearnet connection, when knowing
7373
your address. To mitigate this, additionally bind the address of your Tor proxy:
7474

@@ -81,7 +81,7 @@ as well, use `discover` instead:
8181

8282
and open port 8333 on your firewall (or use -upnp).
8383

84-
If you only want to use Tor to reach onion addresses, but not use it as a proxy
84+
If you only want to use Tor to reach .onion addresses, but not use it as a proxy
8585
for normal IPv4/IPv6 communication, use:
8686

8787
./bitcoind -onion=127.0.0.1:9050 -externalip=57qr3yd1nyntf5k.onion -discover
@@ -101,20 +101,20 @@ requires a Tor connection to work. It can be explicitly disabled with `-listenon
101101
and, if not disabled, configured using the `-torcontrol` and `-torpassword` settings.
102102
To show verbose debugging information, pass `-debug=tor`.
103103

104-
Connecting to Tor's control socket API requires one of two authentication methods to be
105-
configured. For cookie authentication the user running bitcoind must have write access
106-
to the `CookieAuthFile` specified in Tor configuration. In some cases this is
107-
preconfigured and the creation of a hidden service is automatic. If permission problems
108-
are seen with `-debug=tor` they can be resolved by adding both the user running tor and
109-
the user running bitcoind to the same group and setting permissions appropriately. On
110-
Debian-based systems the user running bitcoind can be added to the debian-tor group,
111-
which has the appropriate permissions. An alternative authentication method is the use
112-
of the `-torpassword` flag and a `hash-password` which can be enabled and specified in
104+
Connecting to Tor's control socket API requires one of two authentication methods to be
105+
configured. For cookie authentication the user running bitcoind must have write access
106+
to the `CookieAuthFile` specified in Tor configuration. In some cases, this is
107+
preconfigured and the creation of a hidden service is automatic. If permission problems
108+
are seen with `-debug=tor` they can be resolved by adding both the user running Tor and
109+
the user running bitcoind to the same group and setting permissions appropriately. On
110+
Debian-based systems the user running bitcoind can be added to the debian-tor group,
111+
which has the appropriate permissions. An alternative authentication method is the use
112+
of the `-torpassword` flag and a `hash-password` which can be enabled and specified in
113113
Tor configuration.
114114

115115
## 4. Privacy recommendations
116116

117-
- Do not add anything but bitcoin ports to the hidden service created in section 2.
117+
- Do not add anything but Bitcoin Core ports to the hidden service created in section 2.
118118
If you run a web service too, create a new hidden service for that.
119119
Otherwise it is trivial to link them, which may reduce privacy. Hidden
120120
services created automatically (as in section 3) always have only one port

src/test/data/tx_invalid.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -363,7 +363,7 @@
363363
"010000000144490eda355be7480f2ec828dcc1b9903793a8008fad8cfe9b0c6b4d2f0355a9000000004a483045022100fa4a74ba9fd59c59f46c3960cf90cbe0d2b743c471d24a3d5d6db6002af5eebb02204d70ec490fd0f7055a7c45f86514336e3a7f03503dacecabb247fc23f15c83510151ffffffff010000000000000000016a00000000", "P2SH,CONST_SCRIPTCODE"],
364364

365365

366-
["Using CHECKSIG with singatures in scriptSigs will trigger FindAndDelete, which is invalid"],
366+
["Using CHECKSIG with signatures in scriptSigs will trigger FindAndDelete, which is invalid"],
367367
[[["ccf7f4053a02e653c36ac75c891b7496d0dc5ce5214f6c913d9cf8f1329ebee0", 0, "DUP HASH160 0x14 0xee5a6aa40facefb2655ac23c0c28c57c65c41f9b EQUALVERIFY CHECKSIG"]],
368368
"0100000001e0be9e32f1f89c3d916c4f21e55cdcd096741b895cc76ac353e6023a05f4f7cc00000000d86149304602210086e5f736a2c3622ebb62bd9d93d8e5d76508b98be922b97160edc3dcca6d8c47022100b23c312ac232a4473f19d2aeb95ab7bdf2b65518911a0d72d50e38b5dd31dc820121038479a0fa998cd35259a2ef0a7a5c68662c1474f88ccb6d08a7677bbec7f22041ac4730440220508fa761865c8abd81244a168392876ee1d94e8ed83897066b5e2df2400dad24022043f5ee7538e87e9c6aef7ef55133d3e51da7cc522830a9c4d736977a76ef755c0121038479a0fa998cd35259a2ef0a7a5c68662c1474f88ccb6d08a7677bbec7f22041ffffffff010000000000000000016a00000000", "P2SH,CONST_SCRIPTCODE"],
369369

0 commit comments

Comments
 (0)