From e5143d1e2787fca4ea365c4010e0da5bcbbbba36 Mon Sep 17 00:00:00 2001 Message-Id: In-Reply-To: References: From: Andrea Claudi Date: Mon, 8 Mar 2021 12:52:23 +0100 Subject: [PATCH] iplink_bareudp: cleanup help message and man page Bugzilla: https://bugzilla.redhat.com/show_bug.cgi?id=1912412 Upstream Status: unknown commit 86d9660d commit 86d9660dc1805be4435497ff194f618535e8fc97 Author: Guillaume Nault Date: Mon Feb 1 18:44:07 2021 +0100 iplink_bareudp: cleanup help message and man page * 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 Signed-off-by: Stephen Hemminger --- ip/iplink_bareudp.c | 8 +++++--- man/man8/ip-link.8.in | 15 +++++++++------ 2 files changed, 14 insertions(+), 9 deletions(-) diff --git a/ip/iplink_bareudp.c b/ip/iplink_bareudp.c index 860ec699..aa311106 100644 --- a/ip/iplink_bareudp.c +++ b/ip/iplink_bareudp.c @@ -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" ); } diff --git a/man/man8/ip-link.8.in b/man/man8/ip-link.8.in index f451ecf3..ce3c8636 100644 --- a/man/man8/ip-link.8.in +++ b/man/man8/ip-link.8.in @@ -1304,9 +1304,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 ] @@ -1317,11 +1317,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 @@ -1329,11 +1332,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. -- 2.30.2