diff mbox series

[iproute2-net,6/7] man: mptcp: clarify the 'ID' parameter

Message ID 20240727-upstream-iproute2-net-20240726-mptcp-man-user-feedback-v1-6-c6398c2014ea@kernel.org (mailing list archive)
State Accepted
Commit 8145a842736d1b7dc3f15c1b9024ffdb943824df
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 July 27, 2024, 10:10 a.m. UTC 
Explain the range (u8), and the special case for ID 0.

The endpoints here are for all the connections, while the ID 0 is a
special case per connection, depending on the source address used by the
initial subflow. This ID 0 can then not be used for the global
endpoints.

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

Patch

diff --git a/man/man8/ip-mptcp.8 b/man/man8/ip-mptcp.8
index 4c1161fe..e4a55f6c 100644
--- a/man/man8/ip-mptcp.8
+++ b/man/man8/ip-mptcp.8
@@ -148,7 +148,11 @@  expected behavior.
 
 .TP
 .IR ID
-is a unique numeric identifier for the given endpoint
+is a unique numeric identifier, between 0 and 255, for the given endpoint. It is
+not possible to add endpoints with ID 0, because this special ID is reserved for
+the initial subflow. For rules linked to the initial subflow, the path-manager
+will look at endpoints matching the same address, and port if set, ignoring the
+ID.
 
 .TP
 .BR signal