aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJon Atack <jon@atack.com>2022-03-01 21:13:22 +0100
committerJon Atack <jon@atack.com>2022-03-03 16:14:01 +0100
commita1db99adea36dbee1ec97ca1851edad12137feea (patch)
treeb825cae08a58888b9f679b860a739821fc9e55b8 /doc
parent30308cc380a8176a5ec0e0bd2beed8b9c482ccf7 (diff)
downloadbitcoin-a1db99adea36dbee1ec97ca1851edad12137feea.tar.xz
init, doc: improve -onlynet help and tor/i2p documentation
and harmonize them as follows - s/outgoing/automatic outbound/ - s/Incoming/Inbound and manual/ (are not affected by this option.) - s/only through network/only to network/ - s/this option. This option/this option. It/ - s/network types/networks/ and also pick up a few nits in doc/p2p-bad-ports.md
Diffstat (limited to 'doc')
-rw-r--r--doc/i2p.md6
-rw-r--r--doc/p2p-bad-ports.md6
-rw-r--r--doc/tor.md8
3 files changed, 10 insertions, 10 deletions
diff --git a/doc/i2p.md b/doc/i2p.md
index ee650f3999..e45b5efb9b 100644
--- a/doc/i2p.md
+++ b/doc/i2p.md
@@ -65,9 +65,9 @@ logging` for more information.
-onlynet=i2p
```
-Make outgoing connections only to I2P addresses. Incoming connections are not
-affected by this option. It can be specified multiple times to allow multiple
-network types, e.g. onlynet=onion, onlynet=i2p.
+Make automatic outbound connections only to I2P addresses. Inbound and manual
+connections are not affected by this option. It can be specified multiple times
+to allow multiple networks, e.g. onlynet=onion, onlynet=i2p.
I2P support was added to Bitcoin Core in version 22.0 and there may be fewer I2P
peers than Tor or IP ones. Therefore, using I2P alone without other networks may
diff --git a/doc/p2p-bad-ports.md b/doc/p2p-bad-ports.md
index 0dd7d36cf4..4f717f97a2 100644
--- a/doc/p2p-bad-ports.md
+++ b/doc/p2p-bad-ports.md
@@ -1,6 +1,6 @@
-When Bitcoin Core automatically opens outgoing P2P connections it chooses
+When Bitcoin Core automatically opens outgoing P2P connections, it chooses
a peer (address and port) from its list of potential peers. This list is
-populated with unchecked data, gossiped over the P2P network by other peers.
+populated with unchecked data gossiped over the P2P network by other peers.
A malicious actor may gossip an address:port where no Bitcoin node is listening,
or one where a service is listening that is not related to the Bitcoin network.
@@ -17,7 +17,7 @@ authentication are unlikely to be considered a malicious action,
e.g. port 80 (http).
Below is a list of "bad" ports which Bitcoin Core avoids when choosing a peer to
-connect to. If a node is listening on such a port, it will likely receive less
+connect to. If a node is listening on such a port, it will likely receive fewer
incoming connections.
1: tcpmux
diff --git a/doc/tor.md b/doc/tor.md
index 086e6747bf..b7c4f7d425 100644
--- a/doc/tor.md
+++ b/doc/tor.md
@@ -55,10 +55,10 @@ outgoing connections, but more is possible.
-seednode=X SOCKS5. In Tor mode, such addresses can also be exchanged with
other P2P nodes.
- -onlynet=onion Make outgoing connections only to .onion addresses. Incoming
- connections are not affected by this option. This option can be
- specified multiple times to allow multiple network types, e.g.
- onlynet=onion, onlynet=i2p.
+ -onlynet=onion Make automatic outbound connections only to .onion addresses.
+ Inbound and manual connections are not affected by this option.
+ It can be specified multiple times to allow multiple networks,
+ e.g. onlynet=onion, onlynet=i2p.
In a typical situation, this suffices to run behind a Tor proxy: