Skip to content

Commit 703896a

Browse files
matttbeintel-lab-lkp
authored andcommitted
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: bc8aeb2 ("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) <[email protected]>
1 parent 7502adb commit 703896a

File tree

1 file changed

+16
-15
lines changed

1 file changed

+16
-15
lines changed

Documentation/netlink/specs/mptcp_pm.yaml

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -23,66 +23,67 @@ definitions:
2323
-
2424
name: created
2525
doc:
26-
token, family, saddr4 | saddr6, daddr4 | daddr6, sport, dport,
27-
server-side
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+
The defined attributes are token, family, saddr4 | saddr6, daddr4 |
31+
daddr6, sport, dport, server-side.
3232
-
3333
name: established
3434
doc:
35-
token, family, saddr4 | saddr6, daddr4 | daddr6, sport, dport,
36-
server-side
3735
A MPTCP connection is established (can start new subflows).
36+
The defined attributes are token, family, saddr4 | saddr6, daddr4 |
37+
daddr6, sport, dport, server-side.
3838
-
3939
name: closed
4040
doc:
41-
token
4241
A MPTCP connection has stopped.
42+
The defined attribute is token.
4343
-
4444
name: announced
4545
value: 6
4646
doc:
47-
token, rem_id, family, daddr4 | daddr6 [, dport]
4847
A new address has been announced by the peer.
48+
The defined attributes are token, rem_id, family, daddr4 | daddr6
49+
[, dport].
4950
-
5051
name: removed
5152
doc:
52-
token, rem_id
5353
An address has been lost by the peer.
54+
The defined attributes are token, rem_id.
5455
-
5556
name: sub-established
5657
value: 10
5758
doc:
58-
token, family, loc_id, rem_id, saddr4 | saddr6, daddr4 | daddr6, sport,
59-
dport, backup, if_idx [, error]
6059
A new subflow has been established. 'error' should not be set.
60+
The defined attributes are token, family, loc_id, rem_id, saddr4 |
61+
saddr6, daddr4 | daddr6, sport, dport, backup, if_idx [, error].
6162
-
6263
name: sub-closed
6364
doc:
64-
token, family, loc_id, rem_id, saddr4 | saddr6, daddr4 | daddr6, sport,
65-
dport, backup, if_idx [, error]
6665
A subflow has been closed. An error (copy of sk_err) could be set if an
6766
error has been detected for this subflow.
67+
The defined attributes are token, family, loc_id, rem_id, saddr4 |
68+
saddr6, daddr4 | daddr6, sport, dport, backup, if_idx [, error].
6869
-
6970
name: sub-priority
7071
value: 13
7172
doc:
72-
token, family, loc_id, rem_id, saddr4 | saddr6, daddr4 | daddr6, sport,
73-
dport, backup, if_idx [, error]
7473
The priority of a subflow has changed. 'error' should not be set.
74+
The defined attributes are token, family, loc_id, rem_id, saddr4 |
75+
saddr6, daddr4 | daddr6, sport, dport, backup, if_idx [, error].
7576
-
7677
name: listener-created
7778
value: 15
7879
doc:
79-
family, sport, saddr4 | saddr6
8080
A new PM listener is created.
81+
The defined attributes are family, sport, saddr4 | saddr6.
8182
-
8283
name: listener-closed
8384
doc:
84-
family, sport, saddr4 | saddr6
8585
A PM listener is closed.
86+
The defined attributes are family, sport, saddr4 | saddr6.
8687

8788
attribute-sets:
8889
-

0 commit comments

Comments
 (0)