Commit 9e6dd4c2 authored by Jakub Kicinski's avatar Jakub Kicinski
Browse files

netlink: specs: mptcp: replace underscores with dashes in names 



We're trying to add a strict regexp for the name format in the spec.
Underscores will not be allowed, dashes should be used instead.
This makes no difference to C (codegen, if used, replaces special
chars in names) but it gives more uniform naming in Python.

Fixes: bc8aeb20 ("Documentation: netlink: add a YAML spec for mptcp")
Reviewed-by: default avatarDavide Caratti <dcaratti@redhat.com>
Reviewed-by: default avatarDonald Hunter <donald.hunter@gmail.com>
Reviewed-by: default avatarMatthieu Baerts (NGI0) <matttbe@kernel.org>
Link: https://patch.msgid.link/20250624211002.3475021-8-kuba@kernel.org


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

Documentation/netlink/specs/mptcp_pm.yaml

+4 −4
Original line number Diff line number Diff line
@@ -57,21 +57,21 @@ definitions: 
      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].

        daddr6, sport, dport, backup, if-idx [, error].

     -

      name: sub-closed

      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].

        daddr6, sport, dport, backup, if-idx [, error].

     -

      name: sub-priority

      value: 13

      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].

        daddr6, sport, dport, backup, if-idx [, error].

     -

      name: listener-created

      value: 15
@@ -255,7 +255,7 @@ attribute-sets: 
        name: timeout

        type: u32

      -

        name: if_idx

        name: if-idx

        type: u32

      -

        name: reset-reason

include/uapi/linux/mptcp_pm.h

+3 −3
Original line number Diff line number Diff line
@@ -27,14 +27,14 @@ 
 *   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].

 *   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].

 *   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].

 *   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,