diff mbox series

[iproute2-net,1/7] man: mptcp: document 'dev IFNAME'

Message ID 20240727-upstream-iproute2-net-20240726-mptcp-man-user-feedback-v1-1-c6398c2014ea@kernel.org (mailing list archive)
State Accepted
Commit 484009f46e9c0f76442c402e73fa447afc4e54e8
Delegated to: Stephen Hemminger
Headers show
Series mptcp: improve man pages to avoid confusions | expand

Checks

Context Check Description
netdev/tree_selection success Clearly marked for net
netdev/apply fail Patch does not apply to net-0

Commit Message

Matthieu Baerts (NGI0) July 27, 2024, 10:10 a.m. UTC 
It was missing, while it is a very important option.

Indeed, without it, the kernel might not pick the right interface to
send packets for additional subflows. Mention that in the man page.

Acked-by: Mat Martineau <martineau@kernel.org>
Signed-off-by: Matthieu Baerts (NGI0) <matttbe@kernel.org>
---
 man/man8/ip-mptcp.8 | 8 ++++++++
 1 file changed, 8 insertions(+)
diff mbox series

Patch

diff --git a/man/man8/ip-mptcp.8 b/man/man8/ip-mptcp.8
index 6c708957..89fcb64f 100644
--- a/man/man8/ip-mptcp.8
+++ b/man/man8/ip-mptcp.8
@@ -135,6 +135,14 @@  established MPTCP sockets will be accepted on the specified port, regardless
 the original listener port accepting the first MPTCP subflow and/or
 this peer being actually on the client side.
 
+.TP
+.IR IFNAME
+is the network interface name attached to the endpoint. It is important to
+specify this device name linked to the address to make sure the system knows how
+to route packets from the specified IP address to the correct network interface.
+Without this, it might be required to add IP rules and routes to have the
+expected behavior.
+
 .TP
 .IR ID
 is a unique numeric identifier for the given endpoint