[doc] Improve comment about protected peers

amitiuttarwar · amitiuttarwar · commit ebde946a527e · 2021-03-08T18:17:48.000-08:00
The comment currently suggests a long-standing node would infrequently protect
peers under normal circumstances. Clarify that we also protect peers that are
synced to the same work as our chain tip.
diff --git a/src/net_processing.cpp b/src/net_processing.cpp
@@ -541,7 +541,7 @@ struct CNodeState {
       *   - its connection type is IsBlockOnlyConn() == false
       *   - it gave us a valid connecting header
       *   - we haven't reached MAX_OUTBOUND_PEERS_TO_PROTECT_FROM_DISCONNECT yet
-      *   - it has a better chain than we have
+      *   - its chain tip has at least as much work as ours
       *
       * CHAIN_SYNC_TIMEOUT: if a peer's best known block has less work than our tip,
       * set a timeout CHAIN_SYNC_TIMEOUT seconds in the future:

Original file line number	Diff line number	Diff line change
`@@ -541,7 +541,7 @@ struct CNodeState {`
`541`	`541`	`* - its connection type is IsBlockOnlyConn() == false`
`542`	`542`	`* - it gave us a valid connecting header`
`543`	`543`	`* - we haven't reached MAX_OUTBOUND_PEERS_TO_PROTECT_FROM_DISCONNECT yet`
`544`		`- * - it has a better chain than we have`
	`544`	`+ * - its chain tip has at least as much work as ours`
`545`	`545`	`*`
`546`	`546`	`* CHAIN_SYNC_TIMEOUT: if a peer's best known block has less work than our tip,`
`547`	`547`	`* set a timeout CHAIN_SYNC_TIMEOUT seconds in the future:`