Fix description of 'unconditional peer' behavior (#272)

Author: cordt-sei

config/config.go

@@ -692,7 +692,7 @@ type P2PConfig struct { //nolint: maligned
 	// with the default being "priority".
 	QueueType string `mapstructure:"queue-type"`
 
-	// List of node IDs, to which a connection will be (re)established ignoring any existing limits
+	// List of node IDs, to which a connection will be (re)established, dropping an existing peer if any existing limit has been reached
 	UnconditionalPeerIDs string `mapstructure:"unconditional-peer-ids"`
 }
 

config/toml.go

@@ -348,7 +348,7 @@ send-rate = {{ .P2P.SendRate }}
 # TODO: Remove once MConnConnection is removed.
 recv-rate = {{ .P2P.RecvRate }}
 
-# List of node IDs, to which a connection will be (re)established ignoring any existing limits
+# List of node IDs, to which a connection will be (re)established, dropping an existing peer if any existing limit has been reached
 unconditional-peer-ids = "{{ .P2P.UnconditionalPeerIDs }}"
 
 

internal/p2p/peermanager.go

@@ -97,7 +97,7 @@ type PeerManagerOptions struct {
 	// necessary to make room for these.
 	PersistentPeers []types.NodeID
 
-	// Peers to which a connection will be (re)established ignoring any existing limits
+	// Peers to which a connection will be (re)established, dropping an existing peer if any existing limit has been reached
 	UnconditionalPeers []types.NodeID
 
 	// Only include those peers for block sync
@@ -157,7 +157,7 @@ type PeerManagerOptions struct {
 	// by optimize().
 	persistentPeers map[types.NodeID]bool
 
-	// List of node IDs, to which a connection will be (re)established ignoring any existing limits
+	// List of node IDs, to which a connection will be (re)established, dropping an existing peer if any existing limit has been reached
 	unconditionalPeers map[types.NodeID]struct{}
 
 	// blocksyncPeers provides fast blocksyncPeers lookups.

scripts/confix/testdata/v33-config.toml

@@ -190,7 +190,7 @@ max_num_inbound_peers = 40
 # Maximum number of outbound peers to connect to, excluding persistent peers
 max_num_outbound_peers = 10
 
-# List of node IDs, to which a connection will be (re)established ignoring any existing limits
+# List of node IDs, to which a connection will be (re)established, dropping an existing peer if any existing limit has been reached
 unconditional_peer_ids = ""
 
 # Maximum pause when redialing a persistent peer (if zero, exponential backoff is used)

scripts/confix/testdata/v34-config.toml

@@ -230,7 +230,7 @@ max_num_inbound_peers = 40
 # Maximum number of outbound peers to connect to, excluding persistent peers
 max_num_outbound_peers = 10
 
-# List of node IDs, to which a connection will be (re)established ignoring any existing limits
+# List of node IDs, to which a connection will be (re)established, dropping an existing peer if any existing limit has been reached
 unconditional_peer_ids = ""
 
 # Maximum pause when redialing a persistent peer (if zero, exponential backoff is used)

scripts/confix/testdata/v35-config.toml

@@ -284,7 +284,7 @@ max-connections = 64
 # Rate limits the number of incoming connection attempts per IP address.
 max-incoming-connection-attempts = 100
 
-# List of node IDs, to which a connection will be (re)established ignoring any existing limits
+# List of node IDs, to which a connection will be (re)established, dropping an existing peer if any existing limit has been reached
 # TODO: Remove once p2p refactor is complete.
 # ref: https://github.com/tendermint/tendermint/issues/5670
 unconditional-peer-ids = ""