diff mbox series

[iproute2-next,v2] man: document tunnel options in ip-route.8.in

Message ID e53824a6dc6a300b44d2a58a067722e35d2b74da.1741617346.git.lucien.xin@gmail.com (mailing list archive)
State Accepted
Commit 5e113abad9a45d095791346d1c36dc39c63700d2
Delegated to: Stephen Hemminger
Headers show
Series [iproute2-next,v2] man: document tunnel options in ip-route.8.in | expand

Checks

Context Check Description
netdev/tree_selection success Not a local patch

Commit Message

Xin Long March 10, 2025, 2:35 p.m. UTC 
Add missing tunnel options [GENEVE_OPTS | VXLAN_OPTS | ERSPAN_OPTS] and
their descriptions to ip-route.8.in.

Additionally, document each parameter of the ip ENCAPHDR section, aligning
it with the style used for other ENCAPHDR descriptions. Most of the
content is adapted from tc-tunnel_key.8 for consistency.

Signed-off-by: Xin Long <lucien.xin@gmail.com>
---
v2: correct typo: "Pecified" -> "Specified"
---
 man/man8/ip-route.8.in | 63 +++++++++++++++++++++++++++++++++++++-----
 1 file changed, 56 insertions(+), 7 deletions(-)

Comments

patchwork-bot+netdevbpf@kernel.org March 10, 2025, 4:10 p.m. UTC | #1 
Hello:

This patch was applied to iproute2/iproute2.git (main)
by Stephen Hemminger <stephen@networkplumber.org>:

On Mon, 10 Mar 2025 10:35:46 -0400 you wrote:
> Add missing tunnel options [GENEVE_OPTS | VXLAN_OPTS | ERSPAN_OPTS] and
> their descriptions to ip-route.8.in.
> 
> Additionally, document each parameter of the ip ENCAPHDR section, aligning
> it with the style used for other ENCAPHDR descriptions. Most of the
> content is adapted from tc-tunnel_key.8 for consistency.
> 
> [...]

Here is the summary with links:
  - [iproute2-next,v2] man: document tunnel options in ip-route.8.in
    https://git.kernel.org/pub/scm/network/iproute2/iproute2.git/commit/?id=5e113abad9a4

You are awesome, thank you!
diff mbox series

Patch

diff --git a/man/man8/ip-route.8.in b/man/man8/ip-route.8.in
index 69d445ef..aafa6d98 100644
--- a/man/man8/ip-route.8.in
+++ b/man/man8/ip-route.8.in
@@ -216,7 +216,13 @@  throw " | " unreachable " | " prohibit " | " blackhole " | " nat " ]"
 .B tos
 .IR TOS " ] ["
 .B  ttl
-.IR TTL " ]"
+.IR TTL " ] ["
+.BR key " ] ["
+.BR csum " ] ["
+.BR seq " ] ["
+.IR GENEVE_OPTS " | "
+.IR VXLAN_OPTS " | "
+.IR ERSPAN_OPTS " ]"
 
 .ti -8
 .IR ENCAP_BPF " := "
@@ -783,15 +789,58 @@  is a set of encapsulation attributes specific to the
 .in +2
 .B id
 .I TUNNEL_ID
+- Tunnel ID (for example VNI in VXLAN tunnel)
+.sp
+
 .B  dst
-.IR REMOTE_IP " [ "
+.I REMOTE_IP
+- Outer header destination IP address (IPv4 or IPv6)
+.sp
+
 .B src
-.IR SRC " ] ["
+.I SRC
+- Outer header source IP address (IPv4 or IPv6)
+.sp
+
 .B tos
-.IR TOS " ] ["
-.B  ttl
-.IR TTL " ] [ "
-.BR key " ] [ " csum " ] [ " seq " ] "
+.I TOS
+- Outer header TOS
+.sp
+
+.B ttl
+.I TTL
+- Outer header TTL
+.sp
+
+.B key
+- Outer header flags with key in GRE tunnel
+.sp
+
+.B csum
+- Outer header flags with csum in GRE tunnel
+.sp
+
+.B seq
+- Outer header flags with seq in GRE tunnel
+.sp
+
+.I GENEVE_OPTS
+- Specified in the form CLASS:TYPE:DATA, where CLASS is represented as a
+16bit hexadecimal value, TYPE as an 8bit hexadecimal value and DATA as a
+variable length hexadecimal value. Additionally multiple options may be
+listed using a comma delimiter.
+.sp
+
+.I VXLAN_OPTS
+- Specified in the form GBP, as a 32bit number. Multiple options is not
+supported.
+.sp
+
+.I ERSPAN_OPTS
+- Specified in the form VERSION:INDEX:DIR:HWID, where VERSION is represented
+as a 8bit number, INDEX as an 32bit number, DIR and HWID as a 8bit number.
+Multiple options is not supported. Note INDEX is used when VERSION is 1,
+and DIR and HWID are used when VERSION is 2.
 .in -2
 .sp