From 703896a33d2ca03cbcbf8f06ad6c1b80f2bba9e2 Mon Sep 17 00:00:00 2001 From: "Matthieu Baerts (NGI0)" Date: Fri, 13 Dec 2024 18:55:07 +0100 Subject: [PATCH] netlink: specs: mptcp: clearly mention attributes The rendered version of the MPTCP events [1] looked strange, because the whole content of the 'doc' was displayed in the same block. It was then not clear that the first words, not even ended by a period, were the attributes that are defined when such events are emitted. These attributes have now been moved to the end, prefixed with 'The defined attributes are' and ended with a period. Fixes: bc8aeb2045e2 ("Documentation: netlink: add a YAML spec for mptcp") Link: https://docs.kernel.org/networking/netlink_spec/mptcp_pm.html#event-type [1] Signed-off-by: Matthieu Baerts (NGI0) --- Documentation/netlink/specs/mptcp_pm.yaml | 31 ++++++++++++----------- 1 file changed, 16 insertions(+), 15 deletions(-) diff --git a/Documentation/netlink/specs/mptcp_pm.yaml b/Documentation/netlink/specs/mptcp_pm.yaml index fc0603f51665a6..b9f6bd842eb394 100644 --- a/Documentation/netlink/specs/mptcp_pm.yaml +++ b/Documentation/netlink/specs/mptcp_pm.yaml @@ -23,66 +23,67 @@ definitions: - name: created doc: - token, family, saddr4 | saddr6, daddr4 | daddr6, sport, dport, - server-side A new MPTCP connection has been created. It is the good time to allocate memory and send ADD_ADDR if needed. Depending on the traffic-patterns it can take a long time until the MPTCP_EVENT_ESTABLISHED is sent. + The defined attributes are token, family, saddr4 | saddr6, daddr4 | + daddr6, sport, dport, server-side. - name: established doc: - token, family, saddr4 | saddr6, daddr4 | daddr6, sport, dport, - server-side A MPTCP connection is established (can start new subflows). + The defined attributes are token, family, saddr4 | saddr6, daddr4 | + daddr6, sport, dport, server-side. - name: closed doc: - token A MPTCP connection has stopped. + The defined attribute is token. - name: announced value: 6 doc: - token, rem_id, family, daddr4 | daddr6 [, dport] A new address has been announced by the peer. + The defined attributes are token, rem_id, family, daddr4 | daddr6 + [, dport]. - name: removed doc: - token, rem_id An address has been lost by the peer. + The defined attributes are token, rem_id. - name: sub-established value: 10 doc: - token, family, loc_id, rem_id, saddr4 | saddr6, daddr4 | daddr6, sport, - dport, backup, if_idx [, error] A new subflow has been established. 'error' should not be set. + The defined attributes are token, family, loc_id, rem_id, saddr4 | + saddr6, daddr4 | daddr6, sport, dport, backup, if_idx [, error]. - name: sub-closed doc: - token, family, loc_id, rem_id, saddr4 | saddr6, daddr4 | daddr6, sport, - dport, backup, if_idx [, error] A subflow has been closed. An error (copy of sk_err) could be set if an error has been detected for this subflow. + The defined attributes are token, family, loc_id, rem_id, saddr4 | + saddr6, daddr4 | daddr6, sport, dport, backup, if_idx [, error]. - name: sub-priority value: 13 doc: - token, family, loc_id, rem_id, saddr4 | saddr6, daddr4 | daddr6, sport, - dport, backup, if_idx [, error] The priority of a subflow has changed. 'error' should not be set. + The defined attributes are token, family, loc_id, rem_id, saddr4 | + saddr6, daddr4 | daddr6, sport, dport, backup, if_idx [, error]. - name: listener-created value: 15 doc: - family, sport, saddr4 | saddr6 A new PM listener is created. + The defined attributes are family, sport, saddr4 | saddr6. - name: listener-closed doc: - family, sport, saddr4 | saddr6 A PM listener is closed. + The defined attributes are family, sport, saddr4 | saddr6. attribute-sets: -