Skip to content

Commit 66636ca

Browse files
author
MarcoFalke
committed
Merge bitcoin/bitcoin#24360: doc: improve -netinfo help based on feedback from users and devs
a4da16f Improve -netinfo help based on feedback from users and devs (Jon Atack) Pull request description: Clarify which networks are displayed by the peer counts table (*reachable* networks; follow-up to #23324) in response to questions received over the past months, and a few other improvements. ACKs for top commit: laanwj: Code review ACK a4da16f w0xlt: ACK a4da16f kristapsk: utACK a4da16f Tree-SHA512: e6522c08421aa7f10d50723156d0a8fc5ec82cad2f0bd931bbec603077fcd4921c6505ef743d57386fba81c95dcfc77df75abf3378319886368e4ae33f9a6d73
2 parents 3a618c1 + a4da16f commit 66636ca

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

src/bitcoin-cli.cpp

+7-6
Original file line numberDiff line numberDiff line change
@@ -606,8 +606,9 @@ class NetinfoRequestHandler : public BaseRequestHandler
606606
"Suggestion: use with the Linux watch(1) command for a live dashboard; see example below.\n\n"
607607
"Arguments:\n"
608608
+ strprintf("1. level (integer 0-%d, optional) Specify the info level of the peers dashboard (default 0):\n", MAX_DETAIL_LEVEL) +
609-
" 0 - Connection counts and local addresses\n"
610-
" 1 - Like 0 but with a peers listing (without address or version columns)\n"
609+
" 0 - Peer counts for each reachable network as well as for block relay peers\n"
610+
" and manual peers, and the list of local addresses and ports\n"
611+
" 1 - Like 0 but preceded by a peers listing (without address and version columns)\n"
611612
" 2 - Like 1 but with an address column\n"
612613
" 3 - Like 1 but with a version column\n"
613614
" 4 - Like 1 but with both address and version columns\n"
@@ -645,13 +646,13 @@ class NetinfoRequestHandler : public BaseRequestHandler
645646
" id Peer index, in increasing order of peer connections since node startup\n"
646647
" address IP address and port of the peer\n"
647648
" version Peer version and subversion concatenated, e.g. \"70016/Satoshi:21.0.0/\"\n\n"
648-
"* The connection counts table displays the number of peers by direction, network, and the totals\n"
649-
" for each, as well as two special outbound columns for block relay peers and manual peers.\n\n"
649+
"* The peer counts table displays the number of peers for each reachable network as well as\n"
650+
" the number of block relay peers and manual peers.\n\n"
650651
"* The local addresses table lists each local address broadcast by the node, the port, and the score.\n\n"
651652
"Examples:\n\n"
652-
"Connection counts and local addresses only\n"
653+
"Peer counts table of reachable networks and list of local addresses\n"
653654
"> bitcoin-cli -netinfo\n\n"
654-
"Compact peers listing\n"
655+
"The same, preceded by a peers listing without address and version columns\n"
655656
"> bitcoin-cli -netinfo 1\n\n"
656657
"Full dashboard\n"
657658
+ strprintf("> bitcoin-cli -netinfo %d\n\n", MAX_DETAIL_LEVEL) +

0 commit comments

Comments
 (0)