mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Hangbin Liu <hangbin.liu@linux.dev>
To: David Ahern <dsahern@kernel.org>,
	Ido Schimmel <idosch@nvidia.com>,
	 "David S. Miller" <davem@davemloft.net>,
	Eric Dumazet <edumazet@kernel.org>,
	 Jakub Kicinski <kuba@kernel.org>,
	Paolo Abeni <pabeni@redhat.com>,  Simon Horman <horms@kernel.org>,
	Donald Hunter <donald.hunter@gmail.com>
Cc: Hangbin Liu <hangbin.liu@linux.dev>,
	Wessel Jacobi <wessel@jacobi.pw>,
	 Randy Dunlap <rdunlap@infradead.org>,
	linux-doc@vger.kernel.org,  netdev@vger.kernel.org,
	linux-kernel@vger.kernel.org,
	 Hangbin Liu <liuhangbin@kylinos.cn>
Subject: [PATCH net-next] netlink: specs: rt-route: move fixed-header to operations list
Date: Thu, 12 Nov 2026 14:46:36 +0800	[thread overview]
Message-ID: <20261112-ynl_fixed_header-v1-1-8475ea19e409@kylinos.cn> (raw)

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>


             reply	other threads:[~2026-11-12  6:46 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-11-12  6:46 Hangbin Liu [this message]
2026-11-12  7:30 ` Randy Dunlap

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20261112-ynl_fixed_header-v1-1-8475ea19e409@kylinos.cn \
    --to=hangbin.liu@linux.dev \
    --cc=davem@davemloft.net \
    --cc=donald.hunter@gmail.com \
    --cc=dsahern@kernel.org \
    --cc=edumazet@kernel.org \
    --cc=horms@kernel.org \
    --cc=idosch@nvidia.com \
    --cc=kuba@kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=liuhangbin@kylinos.cn \
    --cc=netdev@vger.kernel.org \
    --cc=pabeni@redhat.com \
    --cc=rdunlap@infradead.org \
    --cc=wessel@jacobi.pw \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®