Skip to content

Commit

Permalink
change description of CLI options
Browse files Browse the repository at this point in the history
  • Loading branch information
StefanBratanov committed Jul 18, 2024
1 parent 934036a commit 50f3d2d
Showing 1 changed file with 6 additions and 10 deletions.
16 changes: 6 additions & 10 deletions teku/src/main/java/tech/pegasys/teku/cli/options/P2POptions.java
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ public class P2POptions {
names = {"--p2p-interface", "--p2p-interfaces"},
paramLabel = "<NETWORK>",
description =
"The network interface(s) on which the node listens for P2P communication. At most 2 can be defined, one of which must be IPv4 and the other IPv6. (Default: 0.0.0.0)",
"The network interface(s) on which the node listens for P2P communication. You can define up to 2 interfaces, with one being IPv4 and the other IPv6. (Default: 0.0.0.0)",
split = ",",
arity = "1..2")
private List<String> p2pInterfaces = NetworkConfig.DEFAULT_P2P_INTERFACE;
Expand All @@ -67,8 +67,7 @@ public class P2POptions {
@Option(
names = {"--p2p-port-ipv6"},
paramLabel = "<INTEGER>",
description =
"P2P IPv6 port. This port is only used when listening over both IPv4 and IPv6. If listening over only IPv6, the value of --p2p-port will be used.",
description = "P2P IPv6 port. This port is only used when listening over both IPv4 and IPv6.",
arity = "1")
private int p2pPortIpv6 = NetworkConfig.DEFAULT_P2P_PORT_IPV6;

Expand All @@ -83,9 +82,7 @@ public class P2POptions {
names = {"--p2p-udp-port-ipv6"},
paramLabel = "<INTEGER>",
description =
"""
IPv6 UDP port used for discovery. This port is only used when listening over both IPv4 and IPv6.
If listening over only IPv6, the value of --p2p-udp-port will be used. The default is the port specified in --p2p-port-ipv6""",
"IPv6 UDP port used for discovery. This port is only used when listening over both IPv4 and IPv6. The default is the port specified in --p2p-port-ipv6",
arity = "1")
private Integer p2pUdpPortIpv6;

Expand All @@ -110,7 +107,7 @@ public class P2POptions {
names = {"--p2p-advertised-ip", "--p2p-advertised-ips"},
paramLabel = "<NETWORK>",
description =
"P2P advertised IP(s). At most 2 can be defined, one of which must be IPv4 and the other IPv6. (Default: 127.0.0.1)",
"P2P advertised IP address(es). You can define up to 2 addresses, with one being IPv4 and the other IPv6. (Default: 127.0.0.1)",
split = ",",
arity = "1..2")
private List<String> p2pAdvertisedIps;
Expand All @@ -127,8 +124,7 @@ public class P2POptions {
paramLabel = "<INTEGER>",
description =
"""
P2P advertised IPv6 port. The default is the port specified in --p2p-port-ipv6. This port is only used when advertising both IPv4 and IPv6 addresses.
If advertising only an IPv6 address, the value of ---p2p-advertised-port will be used.""",
P2P advertised IPv6 port. This port is only used when advertising both IPv4 and IPv6 addresses. The default is the port specified in --p2p-port-ipv6.""",
arity = "1")
private Integer p2pAdvertisedPortIpv6;

Expand All @@ -146,7 +142,7 @@ public class P2POptions {
description =
"""
Advertised IPv6 UDP port to external peers. This port is only used when advertising both IPv4 and IPv6 addresses.
If advertising only an IPv6 address, the value of ---p2p-advertised-udp-port will be used. The default is the port specified in --p2p-advertised-port-ipv6""",
The default is the port specified in --p2p-advertised-port-ipv6.""",
arity = "1")
private Integer p2pAdvertisedUdpPortIpv6;

Expand Down

0 comments on commit 50f3d2d

Please sign in to comment.