Skip to content

Commit 1fa9d91

Browse files
kuba-mookuba-moo
committed
Merge branch 'netlink-specs-mptcp-fixes-for-some-descriptions'
Matthieu Baerts says: ==================== netlink: specs: mptcp: fixes for some descriptions When looking at the MPTCP PM Netlink specs rendered version [1], a few small issues have been found with the descriptions, and fixed here: - Patch 1: add a missing attribute for two events. For >= v5.19. - Patch 2: clearly mention the attributes. For >= v6.7. - Patch 3: fix missing descriptions and replace a wrong one. For >= v6.7. Link: https://docs.kernel.org/networking/netlink_spec/mptcp_pm.html [1] v1: https://lore.kernel.org/20241219-net-mptcp-netlink-specs-pm-doc-fixes-v1-0-825d3b45f27b@kernel.org ==================== Link: https://patch.msgid.link/20241221-net-mptcp-netlink-specs-pm-doc-fixes-v2-0-e54f2db3f844@kernel.org Signed-off-by: Jakub Kicinski <[email protected]>
2 parents b3a69c5 + 4f363fe commit 1fa9d91

File tree

2 files changed

+57
-53
lines changed

2 files changed

+57
-53
lines changed

‎Documentation/netlink/specs/mptcp_pm.yaml

Lines changed: 31 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -22,65 +22,67 @@ definitions:
2222
doc: unused event
2323
-
2424
name: created
25-
doc:
26-
token, family, saddr4 | saddr6, daddr4 | daddr6, sport, dport
25+
doc: >-
2726
A new MPTCP connection has been created. It is the good time to
2827
allocate memory and send ADD_ADDR if needed. Depending on the
2928
traffic-patterns it can take a long time until the
3029
MPTCP_EVENT_ESTABLISHED is sent.
30+
Attributes: token, family, saddr4 | saddr6, daddr4 | daddr6, sport,
31+
dport, server-side.
3132
-
3233
name: established
33-
doc:
34-
token, family, saddr4 | saddr6, daddr4 | daddr6, sport, dport
34+
doc: >-
3535
A MPTCP connection is established (can start new subflows).
36+
Attributes: token, family, saddr4 | saddr6, daddr4 | daddr6, sport,
37+
dport, server-side.
3638
-
3739
name: closed
38-
doc:
39-
token
40+
doc: >-
4041
A MPTCP connection has stopped.
42+
Attribute: token.
4143
-
4244
name: announced
4345
value: 6
44-
doc:
45-
token, rem_id, family, daddr4 | daddr6 [, dport]
46+
doc: >-
4647
A new address has been announced by the peer.
48+
Attributes: token, rem_id, family, daddr4 | daddr6 [, dport].
4749
-
4850
name: removed
49-
doc:
50-
token, rem_id
51+
doc: >-
5152
An address has been lost by the peer.
53+
Attributes: token, rem_id.
5254
-
5355
name: sub-established
5456
value: 10
55-
doc:
56-
token, family, loc_id, rem_id, saddr4 | saddr6, daddr4 | daddr6, sport,
57-
dport, backup, if_idx [, error]
57+
doc: >-
5858
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].
5961
-
6062
name: sub-closed
61-
doc:
62-
token, family, loc_id, rem_id, saddr4 | saddr6, daddr4 | daddr6, sport,
63-
dport, backup, if_idx [, error]
63+
doc: >-
6464
A subflow has been closed. An error (copy of sk_err) could be set if an
6565
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].
6668
-
6769
name: sub-priority
6870
value: 13
69-
doc:
70-
token, family, loc_id, rem_id, saddr4 | saddr6, daddr4 | daddr6, sport,
71-
dport, backup, if_idx [, error]
71+
doc: >-
7272
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].
7375
-
7476
name: listener-created
7577
value: 15
76-
doc:
77-
family, sport, saddr4 | saddr6
78+
doc: >-
7879
A new PM listener is created.
80+
Attributes: family, sport, saddr4 | saddr6.
7981
-
8082
name: listener-closed
81-
doc:
82-
family, sport, saddr4 | saddr6
83+
doc: >-
8384
A PM listener is closed.
85+
Attributes: family, sport, saddr4 | saddr6.
8486
8587
attribute-sets:
8688
-
@@ -306,8 +308,8 @@ operations:
306308
attributes:
307309
- addr
308310
-
309-
name: flush-addrs
310-
doc: flush addresses
311+
name: flush-addrs
312+
doc: Flush addresses
311313
attribute-set: endpoint
312314
dont-validate: [ strict ]
313315
flags: [ uns-admin-perm ]
@@ -351,7 +353,7 @@ operations:
351353
- addr-remote
352354
-
353355
name: announce
354-
doc: announce new sf
356+
doc: Announce new address
355357
attribute-set: attr
356358
dont-validate: [ strict ]
357359
flags: [ uns-admin-perm ]
@@ -362,7 +364,7 @@ operations:
362364
- token
363365
-
364366
name: remove
365-
doc: announce removal
367+
doc: Announce removal
366368
attribute-set: attr
367369
dont-validate: [ strict ]
368370
flags: [ uns-admin-perm ]
@@ -373,7 +375,7 @@ operations:
373375
- loc-id
374376
-
375377
name: subflow-create
376-
doc: todo
378+
doc: Create subflow
377379
attribute-set: attr
378380
dont-validate: [ strict ]
379381
flags: [ uns-admin-perm ]
@@ -385,7 +387,7 @@ operations:
385387
- addr-remote
386388
-
387389
name: subflow-destroy
388-
doc: todo
390+
doc: Destroy subflow
389391
attribute-set: attr
390392
dont-validate: [ strict ]
391393
flags: [ uns-admin-perm ]

‎include/uapi/linux/mptcp_pm.h

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

0 commit comments

Comments
 (0)