noctra/iproute2-next
1
0
Fork 0
Code Issues Pull Requests Releases Activity

iplink_bareudp: cleanup help message and man page

Browse Source 
* Fix PROTO description in help message (mpls isn't a valid argument).

 * Remove SRCPORTMIN description from help message since it doesn't
   appear in the syntax string.

 * Use same keywords in help message and in man page.

 * Use the "ethertype" option name (.B ethertype) rather than the
   option value (.I ETHERTYPE) in the man page description of
   [no]multiproto.

Signed-off-by: Guillaume Nault <gnault@redhat.com>
Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
This commit is contained in:
Guillaume Nault
2021-02-01 18:44:07 +01:00
committed by Stephen Hemminger
parent 8498ca92d7
commit 86d9660dc1
2 changed files with 14 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
ip/iplink_bareudp.c
View File

@@ -22,9 +22,11 @@ static void print_explain(FILE *f)
" [ srcportmin PORT ]\n"
" [ [no]multiproto ]\n"
"\n"
"Where: PORT := 0-65535\n"
" PROTO := NUMBER | ip | mpls\n"
" SRCPORTMIN := 0-65535\n"
"Where: PORT := UDP_PORT\n"
" PROTO := ETHERTYPE\n"
"\n"
"Note: ETHERTYPE can be given as number or as protocol name (\"ipv4\", \"ipv6\",\n"
" \"mpls_uc\", etc.).\n"
);
}

15
man/man8/ip-link.8.in
View File

@@ -1307,9 +1307,9 @@ For a link of type
the following additional arguments are supported:
.BI "ip link add " DEVICE
.BI type " bareudp " dstport " PORT " ethertype " ETHERTYPE"
.BI type " bareudp " dstport " PORT " ethertype " PROTO"
[
.BI srcportmin " SRCPORTMIN "
.BI srcportmin " PORT "
] [
.RB [ no ] multiproto
]
@@ -1320,11 +1320,14 @@ the following additional arguments are supported:
- specifies the destination port for the UDP tunnel.
.sp
.BI ethertype " ETHERTYPE"
.BI ethertype " PROTO"
- specifies the ethertype of the L3 protocol being tunnelled.
.B ethertype
can be given as plain Ethernet protocol number or using the protocol name
("ipv4", "ipv6", "mpls_uc", etc.).
.sp
.BI srcportmin " SRCPORTMIN"
.BI srcportmin " PORT"
- selects the lowest value of the UDP tunnel source port range.
.sp
@@ -1332,11 +1335,11 @@ the following additional arguments are supported:
- activates support for protocols similar to the one
.RB "specified by " ethertype .
When
.I ETHERTYPE
.B ethertype
is "mpls_uc" (that is, unicast MPLS), this allows the tunnel to also handle
multicast MPLS.
When
.I ETHERTYPE
.B ethertype
is "ipv4", this allows the tunnel to also handle IPv6. This option is disabled
by default.