[PATCH net-next] netlink: specs: rt-route: move fixed-header to operations list

[PATCH net-next] netlink: specs: rt-route: move fixed-header to operations list

[Hangbin Liu]

From: Hangbin Liu <liuhangbin@kylinos.cn>

Wessel reported that fixed-header is not shown in the generated HTML
page like rt-link.yaml. The doc generator only renders fields on each
entry in the operations list, not operations-level keys. Move
fixed-header onto each operation so it appears in the HTML.

Reported-by: Wessel Jacobi <wessel@jacobi.pw>
Closes: https://patch.msgid.link/8610ee11-e1dc-481a-9654-11188a06786a@jacobi.pw
Signed-off-by: Hangbin Liu <liuhangbin@kylinos.cn>
---
I'm not very sure whether we should also set `fixed-header` for
`newroute-ntf` and `delroute-ntf`, since these notifications are identical
to `getroute`. But because `fixed-header` is defined at the operations
level, I've added it to all list fields to match the existing behavior.

I rebuilt the HTML documentation, and now `fixed-header` shows up correctly.
---
 Documentation/netlink/specs/rt-route.yaml | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/Documentation/netlink/specs/rt-route.yaml b/Documentation/netlink/specs/rt-route.yaml
index 48d1659f20f3..b5786b465eef 100644
--- a/Documentation/netlink/specs/rt-route.yaml
+++ b/Documentation/netlink/specs/rt-route.yaml
@@ -708,13 +708,13 @@ attribute-sets:
 
 operations:
   enum-model: directional
-  fixed-header: rtmsg
   name-prefix: rtm-
   list:
     -
       name: getroute
       doc: Dump route information.
       attribute-set: route-attrs
+      fixed-header: rtmsg
       do:
         request:
           value: 26
@@ -772,6 +772,7 @@ operations:
       name: newroute
       doc: Create a new route
       attribute-set: route-attrs
+      fixed-header: rtmsg
       do:
         request:
           value: 24
@@ -808,6 +809,7 @@ operations:
       name: delroute
       doc: Delete an existing route
       attribute-set: route-attrs
+      fixed-header: rtmsg
       do:
         request:
           value: 25
@@ -815,11 +817,13 @@ operations:
     -
       name: newroute-ntf
       doc: Notification about a created route.
+      fixed-header: rtmsg
       value: 24
       notify: getroute
     -
       name: delroute-ntf
       doc: Notification about a deleted route.
+      fixed-header: rtmsg
       value: 25
       notify: getroute
 

---
base-commit: c88fd6989aea9237a60a4859139a265bfb7ddc0b
change-id: 20261112-ynl_fixed_header-2d7acfcb54f8

Best regards,
--  
Hangbin Liu <liuhangbin@kylinos.cn>

Re: [PATCH net-next] netlink: specs: rt-route: move fixed-header to operations list

[Randy Dunlap]

On 11/11/26 10:46 PM, Hangbin Liu wrote:
> From: Hangbin Liu <liuhangbin@kylinos.cn>
> 
> Wessel reported that fixed-header is not shown in the generated HTML
> page like rt-link.yaml. The doc generator only renders fields on each
> entry in the operations list, not operations-level keys. Move
> fixed-header onto each operation so it appears in the HTML.
> 
> Reported-by: Wessel Jacobi <wessel@jacobi.pw>
> Closes: https://patch.msgid.link/8610ee11-e1dc-481a-9654-11188a06786a@jacobi.pw
> Signed-off-by: Hangbin Liu <liuhangbin@kylinos.cn>

Acked-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

> ---
> I'm not very sure whether we should also set `fixed-header` for
> `newroute-ntf` and `delroute-ntf`, since these notifications are identical
> to `getroute`. But because `fixed-header` is defined at the operations
> level, I've added it to all list fields to match the existing behavior.
> 
> I rebuilt the HTML documentation, and now `fixed-header` shows up correctly.
> ---
>  Documentation/netlink/specs/rt-route.yaml | 6 +++++-
>  1 file changed, 5 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/netlink/specs/rt-route.yaml b/Documentation/netlink/specs/rt-route.yaml
> index 48d1659f20f3..b5786b465eef 100644
> --- a/Documentation/netlink/specs/rt-route.yaml
> +++ b/Documentation/netlink/specs/rt-route.yaml
> @@ -708,13 +708,13 @@ attribute-sets:
>  
>  operations:
>    enum-model: directional
> -  fixed-header: rtmsg
>    name-prefix: rtm-
>    list:
>      -
>        name: getroute
>        doc: Dump route information.
>        attribute-set: route-attrs
> +      fixed-header: rtmsg
>        do:
>          request:
>            value: 26
> @@ -772,6 +772,7 @@ operations:
>        name: newroute
>        doc: Create a new route
>        attribute-set: route-attrs
> +      fixed-header: rtmsg
>        do:
>          request:
>            value: 24
> @@ -808,6 +809,7 @@ operations:
>        name: delroute
>        doc: Delete an existing route
>        attribute-set: route-attrs
> +      fixed-header: rtmsg
>        do:
>          request:
>            value: 25
> @@ -815,11 +817,13 @@ operations:
>      -
>        name: newroute-ntf
>        doc: Notification about a created route.
> +      fixed-header: rtmsg
>        value: 24
>        notify: getroute
>      -
>        name: delroute-ntf
>        doc: Notification about a deleted route.
> +      fixed-header: rtmsg
>        value: 25
>        notify: getroute
>  
> 
> ---
> base-commit: c88fd6989aea9237a60a4859139a265bfb7ddc0b
> change-id: 20261112-ynl_fixed_header-2d7acfcb54f8
> 
> Best regards,
> --  
> Hangbin Liu <liuhangbin@kylinos.cn>
> 
> 

-- 
~Randy