Skip to content

Commit bea8765

Browse files
matttbekuba-moo
matttbe
authored and
kuba-moo
committed
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 by 'Attributes:' and ended with a period. Note that '>-' has been added after 'doc:' to allow ':' in the text below. The documentation in the UAPI header has been auto-generated by: ./tools/net/ynl/ynl-regen.sh Link: https://docs.kernel.org/networking/netlink_spec/mptcp_pm.html#event-type [1] Reviewed-by: Geliang Tang <[email protected]> Signed-off-by: Matthieu Baerts (NGI0) <[email protected]> Link: https://patch.msgid.link/20241221-net-mptcp-netlink-specs-pm-doc-fixes-v2-2-e54f2db3f844@kernel.org Signed-off-by: Jakub Kicinski <[email protected]>
1 parent 6b830c6 commit bea8765

File tree

2 files changed

+52
-51
lines changed

2 files changed

+52
-51
lines changed

‎Documentation/netlink/specs/mptcp_pm.yaml‎

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -22,67 +22,67 @@ definitions:
2222
doc: unused event
2323
-
2424
name: created
25-
doc:
26-
token, family, saddr4 | saddr6, daddr4 | daddr6, sport, dport,
27-
server-side
25+
doc: >-
2826
A new MPTCP connection has been created. It is the good time to
2927
allocate memory and send ADD_ADDR if needed. Depending on the
3028
traffic-patterns it can take a long time until the
3129
MPTCP_EVENT_ESTABLISHED is sent.
30+
Attributes: token, family, saddr4 | saddr6, daddr4 | daddr6, sport,
31+
dport, server-side.
3232
-
3333
name: established
34-
doc:
35-
token, family, saddr4 | saddr6, daddr4 | daddr6, sport, dport,
36-
server-side
34+
doc: >-
3735
A MPTCP connection is established (can start new subflows).
36+
Attributes: token, family, saddr4 | saddr6, daddr4 | daddr6, sport,
37+
dport, server-side.
3838
-
3939
name: closed
40-
doc:
41-
token
40+
doc: >-
4241
A MPTCP connection has stopped.
42+
Attribute: token.
4343
-
4444
name: announced
4545
value: 6
46-
doc:
47-
token, rem_id, family, daddr4 | daddr6 [, dport]
46+
doc: >-
4847
A new address has been announced by the peer.
48+
Attributes: token, rem_id, family, daddr4 | daddr6 [, dport].
4949
-
5050
name: removed
51-
doc:
52-
token, rem_id
51+
doc: >-
5352
An address has been lost by the peer.
53+
Attributes: token, rem_id.
5454
-
5555
name: sub-established
5656
value: 10
57-
doc:
58-
token, family, loc_id, rem_id, saddr4 | saddr6, daddr4 | daddr6, sport,
59-
dport, backup, if_idx [, error]
57+
doc: >-
6058
A new subflow has been established. 'error' should not be set.
59+
Attributes: token, family, loc_id, rem_id, saddr4 | saddr6, daddr4 |
60+
daddr6, sport, dport, backup, if_idx [, error].
6161
-
6262
name: sub-closed
63-
doc:
64-
token, family, loc_id, rem_id, saddr4 | saddr6, daddr4 | daddr6, sport,
65-
dport, backup, if_idx [, error]
63+
doc: >-
6664
A subflow has been closed. An error (copy of sk_err) could be set if an
6765
error has been detected for this subflow.
66+
Attributes: token, family, loc_id, rem_id, saddr4 | saddr6, daddr4 |
67+
daddr6, sport, dport, backup, if_idx [, error].
6868
-
6969
name: sub-priority
7070
value: 13
71-
doc:
72-
token, family, loc_id, rem_id, saddr4 | saddr6, daddr4 | daddr6, sport,
73-
dport, backup, if_idx [, error]
71+
doc: >-
7472
The priority of a subflow has changed. 'error' should not be set.
73+
Attributes: token, family, loc_id, rem_id, saddr4 | saddr6, daddr4 |
74+
daddr6, sport, dport, backup, if_idx [, error].
7575
-
7676
name: listener-created
7777
value: 15
78-
doc:
79-
family, sport, saddr4 | saddr6
78+
doc: >-
8079
A new PM listener is created.
80+
Attributes: family, sport, saddr4 | saddr6.
8181
-
8282
name: listener-closed
83-
doc:
84-
family, sport, saddr4 | saddr6
83+
doc: >-
8584
A PM listener is closed.
85+
Attributes: family, sport, saddr4 | saddr6.
8686
8787
attribute-sets:
8888
-

‎include/uapi/linux/mptcp_pm.h‎

Lines changed: 27 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -12,32 +12,33 @@
1212
/**
1313
* enum mptcp_event_type
1414
* @MPTCP_EVENT_UNSPEC: unused event
15-
* @MPTCP_EVENT_CREATED: token, family, saddr4 | saddr6, daddr4 | daddr6,
16-
* sport, dport, server-side A new MPTCP connection has been created. It is
17-
* the good time to allocate memory and send ADD_ADDR if needed. Depending on
18-
* the traffic-patterns it can take a long time until the
19-
* MPTCP_EVENT_ESTABLISHED is sent.
20-
* @MPTCP_EVENT_ESTABLISHED: token, family, saddr4 | saddr6, daddr4 | daddr6,
21-
* sport, dport, server-side A MPTCP connection is established (can start new
22-
* subflows).
23-
* @MPTCP_EVENT_CLOSED: token A MPTCP connection has stopped.
24-
* @MPTCP_EVENT_ANNOUNCED: token, rem_id, family, daddr4 | daddr6 [, dport] A
25-
* new address has been announced by the peer.
26-
* @MPTCP_EVENT_REMOVED: token, rem_id An address has been lost by the peer.
27-
* @MPTCP_EVENT_SUB_ESTABLISHED: token, family, loc_id, rem_id, saddr4 |
28-
* saddr6, daddr4 | daddr6, sport, dport, backup, if_idx [, error] A new
29-
* subflow has been established. 'error' should not be set.
30-
* @MPTCP_EVENT_SUB_CLOSED: token, family, loc_id, rem_id, saddr4 | saddr6,
31-
* daddr4 | daddr6, sport, dport, backup, if_idx [, error] A subflow has been
32-
* closed. An error (copy of sk_err) could be set if an error has been
33-
* detected for this subflow.
34-
* @MPTCP_EVENT_SUB_PRIORITY: token, family, loc_id, rem_id, saddr4 | saddr6,
35-
* daddr4 | daddr6, sport, dport, backup, if_idx [, error] The priority of a
36-
* subflow has changed. 'error' should not be set.
37-
* @MPTCP_EVENT_LISTENER_CREATED: family, sport, saddr4 | saddr6 A new PM
38-
* listener is created.
39-
* @MPTCP_EVENT_LISTENER_CLOSED: family, sport, saddr4 | saddr6 A PM listener
40-
* is closed.
15+
* @MPTCP_EVENT_CREATED: A new MPTCP connection has been created. It is the
16+
* good time to allocate memory and send ADD_ADDR if needed. Depending on the
17+
* traffic-patterns it can take a long time until the MPTCP_EVENT_ESTABLISHED
18+
* is sent. Attributes: token, family, saddr4 | saddr6, daddr4 | daddr6,
19+
* sport, dport, server-side.
20+
* @MPTCP_EVENT_ESTABLISHED: A MPTCP connection is established (can start new
21+
* subflows). Attributes: token, family, saddr4 | saddr6, daddr4 | daddr6,
22+
* sport, dport, server-side.
23+
* @MPTCP_EVENT_CLOSED: A MPTCP connection has stopped. Attribute: token.
24+
* @MPTCP_EVENT_ANNOUNCED: A new address has been announced by the peer.
25+
* Attributes: token, rem_id, family, daddr4 | daddr6 [, dport].
26+
* @MPTCP_EVENT_REMOVED: An address has been lost by the peer. Attributes:
27+
* token, rem_id.
28+
* @MPTCP_EVENT_SUB_ESTABLISHED: A new subflow has been established. 'error'
29+
* should not be set. Attributes: token, family, loc_id, rem_id, saddr4 |
30+
* saddr6, daddr4 | daddr6, sport, dport, backup, if_idx [, error].
31+
* @MPTCP_EVENT_SUB_CLOSED: A subflow has been closed. An error (copy of
32+
* sk_err) could be set if an error has been detected for this subflow.
33+
* Attributes: token, family, loc_id, rem_id, saddr4 | saddr6, daddr4 |
34+
* daddr6, sport, dport, backup, if_idx [, error].
35+
* @MPTCP_EVENT_SUB_PRIORITY: The priority of a subflow has changed. 'error'
36+
* should not be set. Attributes: token, family, loc_id, rem_id, saddr4 |
37+
* saddr6, daddr4 | daddr6, sport, dport, backup, if_idx [, error].
38+
* @MPTCP_EVENT_LISTENER_CREATED: A new PM listener is created. Attributes:
39+
* family, sport, saddr4 | saddr6.
40+
* @MPTCP_EVENT_LISTENER_CLOSED: A PM listener is closed. Attributes: family,
41+
* sport, saddr4 | saddr6.
4142
*/
4243
enum mptcp_event_type {
4344
MPTCP_EVENT_UNSPEC,

0 commit comments

Comments
 (0)