mbox series

[iproute2-net,0/7] mptcp: improve man pages to avoid confusions

Message ID 20240727-upstream-iproute2-net-20240726-mptcp-man-user-feedback-v1-0-c6398c2014ea@kernel.org (mailing list archive)
Headers show
Series mptcp: improve man pages to avoid confusions | expand

Message

Matthieu Baerts (NGI0) July 27, 2024, 10:10 a.m. UTC
According to some bug reports we had in the past, setting the MPTCP
endpoints might be confusing, and the wrong flags might be set.

This series adds missing info for the 'dev' parameter in the manual, but
also clarify a few other parameters.

While at it, a better error message is reported when 'id 0' is used to
'add' or 'change' an endpoint.

Signed-off-by: Matthieu Baerts (NGI0) <matttbe@kernel.org>
---
Matthieu Baerts (NGI0) (7):
      man: mptcp: document 'dev IFNAME'
      man: mptcp: clarify 'signal' and 'subflow' flags
      man: mptcp: 'port' has to be used with 'signal'
      man: mptcp: 'backup' flag also affects outgoing data
      man: mptcp: 'fullmesh' has to be used with 'subflow'
      man: mptcp: clarify the 'ID' parameter
      ip: mptcp: 'id 0' is only for 'del'

 ip/ipmptcp.c        |  2 ++
 man/man8/ip-mptcp.8 | 44 +++++++++++++++++++++++++++++++++++---------
 2 files changed, 37 insertions(+), 9 deletions(-)
---
base-commit: 3e807112fdf3d7b89a8295379dd8474f08a38b4b
change-id: 20240726-upstream-iproute2-net-20240726-mptcp-man-user-feedback-97612666993b

Best regards,

Comments

patchwork-bot+netdevbpf@kernel.org Aug. 2, 2024, 5:50 p.m. UTC | #1
Hello:

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

On Sat, 27 Jul 2024 12:10:29 +0200 you wrote:
> According to some bug reports we had in the past, setting the MPTCP
> endpoints might be confusing, and the wrong flags might be set.
> 
> This series adds missing info for the 'dev' parameter in the manual, but
> also clarify a few other parameters.
> 
> While at it, a better error message is reported when 'id 0' is used to
> 'add' or 'change' an endpoint.
> 
> [...]

Here is the summary with links:
  - [iproute2-net,1/7] man: mptcp: document 'dev IFNAME'
    https://git.kernel.org/pub/scm/network/iproute2/iproute2.git/commit/?id=484009f46e9c
  - [iproute2-net,2/7] man: mptcp: clarify 'signal' and 'subflow' flags
    https://git.kernel.org/pub/scm/network/iproute2/iproute2.git/commit/?id=80392875faa8
  - [iproute2-net,3/7] man: mptcp: 'port' has to be used with 'signal'
    https://git.kernel.org/pub/scm/network/iproute2/iproute2.git/commit/?id=8251786f3d81
  - [iproute2-net,4/7] man: mptcp: 'backup' flag also affects outgoing data
    https://git.kernel.org/pub/scm/network/iproute2/iproute2.git/commit/?id=e3c1e2a4e20d
  - [iproute2-net,5/7] man: mptcp: 'fullmesh' has to be used with 'subflow'
    https://git.kernel.org/pub/scm/network/iproute2/iproute2.git/commit/?id=640ebc23d8ab
  - [iproute2-net,6/7] man: mptcp: clarify the 'ID' parameter
    https://git.kernel.org/pub/scm/network/iproute2/iproute2.git/commit/?id=8145a842736d
  - [iproute2-net,7/7] ip: mptcp: 'id 0' is only for 'del'
    https://git.kernel.org/pub/scm/network/iproute2/iproute2.git/commit/?id=b176b9f40368

You are awesome, thank you!