| Message ID | 20241219-net-mptcp-netlink-specs-pm-doc-fixes-v1-0-825d3b45f27b@kernel.org (mailing list archive) |
|---|---|
| Headers | show |
| Series | netlink: specs: mptcp: fixes for some descriptions | expand |
On Thu, 19 Dec 2024 12:45:26 +0100 Matthieu Baerts (NGI0) wrote: > 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. I'm going to treat this as documentation fixes, so perfectly fine for net but they don't need Fixes tags. Hope that's okay, and that I'm not missing anything. > Link: https://docs.kernel.org/networking/netlink_spec/mptcp_pm.html [1] > Signed-off-by: Matthieu Baerts (NGI0) <matttbe@kernel.org> > --- > Please note that there is no urgency here: this can of course be sent to > Linus next year! > > Enjoy this holiday period! Thank you! You too!
On Fri, 20 Dec 2024 11:54:06 -0800 Jakub Kicinski wrote: > On Thu, 19 Dec 2024 12:45:26 +0100 Matthieu Baerts (NGI0) wrote: > > 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. > > I'm going to treat this as documentation fixes, so perfectly fine for > net but they don't need Fixes tags. Hope that's okay, and that I'm > not missing anything. Ah, these also need a regen since the kdoc has changed! please run ./tools/net/ynl/ynl-regen.sh
Hi Jakub, Thank you for the review! On 20/12/2024 20:56, Jakub Kicinski wrote: > On Fri, 20 Dec 2024 11:54:06 -0800 Jakub Kicinski wrote: >> On Thu, 19 Dec 2024 12:45:26 +0100 Matthieu Baerts (NGI0) wrote: >>> 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. >> >> I'm going to treat this as documentation fixes, so perfectly fine for >> net but they don't need Fixes tags. Hope that's okay, and that I'm >> not missing anything. > > Ah, these also need a regen since the kdoc has changed! > > please run ./tools/net/ynl/ynl-regen.sh Oh, sorry, I didn't know. I will fix that in a v2 without the Fixes and cc stable. Cheers, Matt
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] Signed-off-by: Matthieu Baerts (NGI0) <matttbe@kernel.org> --- Please note that there is no urgency here: this can of course be sent to Linus next year! Enjoy this holiday period! --- Matthieu Baerts (NGI0) (3): netlink: specs: mptcp: add missing 'server-side' attr netlink: specs: mptcp: clearly mention attributes netlink: specs: mptcp: fix missing doc Documentation/netlink/specs/mptcp_pm.yaml | 60 ++++++++++++++++--------------- 1 file changed, 31 insertions(+), 29 deletions(-) --- base-commit: ce1219c3f76bb131d095e90521506d3c6ccfa086 change-id: 20241219-net-mptcp-netlink-specs-pm-doc-fixes-618a2e8f6aeb Best regards,