]> www.infradead.org Git - users/dwmw2/linux.git/commit
netlink: specs: mptcp: clearly mention attributes
authorMatthieu Baerts (NGI0) <matttbe@kernel.org>
Sat, 21 Dec 2024 11:09:15 +0000 (12:09 +0100)
committerJakub Kicinski <kuba@kernel.org>
Fri, 27 Dec 2024 19:16:21 +0000 (11:16 -0800)
commitbea87657b5ee8e6f18af2833ee4b88212ef52d28
tree95c01c6da0709bef249fd482e0deac6b190517f5
parent6b830c6a023ff6e8fe05dbe47a9e5cd276df09ee
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
Reviewed-by: Geliang Tang <geliang@kernel.org>
Signed-off-by: Matthieu 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: Jakub Kicinski <kuba@kernel.org>
Documentation/netlink/specs/mptcp_pm.yaml
include/uapi/linux/mptcp_pm.h