Commit bea87657 authored by Matthieu Baerts (NGI0)'s avatar Matthieu Baerts (NGI0) Committed by Jakub Kicinski
Browse files

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: default avatarGeliang Tang <geliang@kernel.org>
Signed-off-by: default avatarMatthieu Baerts (NGI0) <matttbe@kernel.org>
Link: https://patch.msgid.link/20241221-net-mptcp-netlink-specs-pm-doc-fixes-v2-2-e54f2db3f844@kernel.org


Signed-off-by: default avatarJakub Kicinski <kuba@kernel.org>
parent 6b830c6a

Documentation/netlink/specs/mptcp_pm.yaml

+25 −25
Original line number Diff line number Diff line
@@ -22,67 +22,67 @@ definitions: 
      doc: unused event

     -

      name: created

      doc:

        token, family, saddr4 | saddr6, daddr4 | daddr6, sport, dport,

        server-side

      doc: >-

        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.

        Attributes: token, family, saddr4 | saddr6, daddr4 | daddr6, sport,

        dport, server-side.

     -

      name: established

      doc:

        token, family, saddr4 | saddr6, daddr4 | daddr6, sport, dport,

        server-side

      doc: >-

        A MPTCP connection is established (can start new subflows).

        Attributes: token, family, saddr4 | saddr6, daddr4 | daddr6, sport,

        dport, server-side.

     -

      name: closed

      doc:

        token

      doc: >-

        A MPTCP connection has stopped.

        Attribute: token.

     -

      name: announced

      value: 6

      doc:

        token, rem_id, family, daddr4 | daddr6 [, dport]

      doc: >-

        A new address has been announced by the peer.

        Attributes: token, rem_id, family, daddr4 | daddr6 [, dport].

     -

      name: removed

      doc:

        token, rem_id

      doc: >-

        An address has been lost by the peer.

        Attributes: 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]

      doc: >-

        A new subflow has been established. 'error' should not be set.

        Attributes: 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]

      doc: >-

        A subflow has been closed. An error (copy of sk_err) could be set if an

        error has been detected for this subflow.

        Attributes: 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]

      doc: >-

        The priority of a subflow has changed. 'error' should not be set.

        Attributes: 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

      doc: >-

        A new PM listener is created.

        Attributes: family, sport, saddr4 | saddr6.

     -

      name: listener-closed

      doc:

        family, sport, saddr4 | saddr6

      doc: >-

        A PM listener is closed.

        Attributes: family, sport, saddr4 | saddr6.



attribute-sets:

  -

include/uapi/linux/mptcp_pm.h

+27 −26
Original line number Diff line number Diff line
@@ -12,32 +12,33 @@ 
/**

 * enum mptcp_event_type

 * @MPTCP_EVENT_UNSPEC: unused event

 * @MPTCP_EVENT_CREATED: 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.

 * @MPTCP_EVENT_ESTABLISHED: token, family, saddr4 | saddr6, daddr4 | daddr6,

 *   sport, dport, server-side A MPTCP connection is established (can start new

 *   subflows).

 * @MPTCP_EVENT_CLOSED: token A MPTCP connection has stopped.

 * @MPTCP_EVENT_ANNOUNCED: token, rem_id, family, daddr4 | daddr6 [, dport] A

 *   new address has been announced by the peer.

 * @MPTCP_EVENT_REMOVED: token, rem_id An address has been lost by the peer.

 * @MPTCP_EVENT_SUB_ESTABLISHED: 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.

 * @MPTCP_EVENT_SUB_CLOSED: 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.

 * @MPTCP_EVENT_SUB_PRIORITY: 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.

 * @MPTCP_EVENT_LISTENER_CREATED: family, sport, saddr4 | saddr6 A new PM

 *   listener is created.

 * @MPTCP_EVENT_LISTENER_CLOSED: family, sport, saddr4 | saddr6 A PM listener

 *   is closed.

 * @MPTCP_EVENT_CREATED: 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. Attributes: token, family, saddr4 | saddr6, daddr4 | daddr6,

 *   sport, dport, server-side.

 * @MPTCP_EVENT_ESTABLISHED: A MPTCP connection is established (can start new

 *   subflows). Attributes: token, family, saddr4 | saddr6, daddr4 | daddr6,

 *   sport, dport, server-side.

 * @MPTCP_EVENT_CLOSED: A MPTCP connection has stopped. Attribute: token.

 * @MPTCP_EVENT_ANNOUNCED: A new address has been announced by the peer.

 *   Attributes: token, rem_id, family, daddr4 | daddr6 [, dport].

 * @MPTCP_EVENT_REMOVED: An address has been lost by the peer. Attributes:

 *   token, rem_id.

 * @MPTCP_EVENT_SUB_ESTABLISHED: A new subflow has been established. 'error'

 *   should not be set. Attributes: token, family, loc_id, rem_id, saddr4 |

 *   saddr6, daddr4 | daddr6, sport, dport, backup, if_idx [, error].

 * @MPTCP_EVENT_SUB_CLOSED: A subflow has been closed. An error (copy of

 *   sk_err) could be set if an error has been detected for this subflow.

 *   Attributes: token, family, loc_id, rem_id, saddr4 | saddr6, daddr4 |

 *   daddr6, sport, dport, backup, if_idx [, error].

 * @MPTCP_EVENT_SUB_PRIORITY: The priority of a subflow has changed. 'error'

 *   should not be set. Attributes: token, family, loc_id, rem_id, saddr4 |

 *   saddr6, daddr4 | daddr6, sport, dport, backup, if_idx [, error].

 * @MPTCP_EVENT_LISTENER_CREATED: A new PM listener is created. Attributes:

 *   family, sport, saddr4 | saddr6.

 * @MPTCP_EVENT_LISTENER_CLOSED: A PM listener is closed. Attributes: family,

 *   sport, saddr4 | saddr6.

 */

enum mptcp_event_type {

	MPTCP_EVENT_UNSPEC,