Netdev List
 help / color / mirror / Atom feed
From: Hangbin Liu <liuhangbin@kylinos.cn>
To: Randy Dunlap <rdunlap@infradead.org>
Cc: Wessel Jacobi <wessel@jacobi.pw>,
	linux-doc@vger.kernel.org, Jakub Kicinski <kuba@kernel.org>,
	Hangbin Liu <hangbin.liu@linux.dev>,
	Linux Networking <netdev@vger.kernel.org>,
	Paolo Abeni <pabeni@redhat.com>,
	Yuyang Huang <sigefriedhyy@gmail.com>,
	Donald Hunter <donald.hunter@gmail.com>
Subject: Re: Documentation suggestion on Netlink specs: missing fixed-header info
Date: Thu, 12 Nov 2026 11:14:22 +0800	[thread overview]
Message-ID: <avUvDvhSnp1c-q0E@fedora> (raw)
In-Reply-To: <cff30946-5984-4d69-a590-3c7291d8f32c@infradead.org>

Hi Randy,
On Wed, Nov 11, 2026 at 06:16:51PM -0800, Randy Dunlap wrote:
> Hi netdev:
> 
> Does anyone know what this means and what to do about it?
> Thanks.

Wessel noted that the `fixed-header` field appears in `rt-link.html` but is
missing from `rt-route.html`, even though the field is present in `rt-route.yaml`.

I think it is because we put it in the operations in rt-route.yaml.

  operations:
    enum-model: directional
    fixed-header: rtmsg
    name-prefix: rtm-
    list:

While in rt-link.yaml it's in the list field

  operations:
    enum-model: directional
    name-prefix: rtm-
    list:
      -
        name: newlink
        doc: Create a new link.
        attribute-set: link-attrs
        fixed-header: ifinfomsg

I will do a test and post the update if works.

Thanks
Hangbin

> 
> On 11/5/26 2:48 AM, Wessel Jacobi wrote:
> > Hello,
> > 
> > The "fixed-header" information is missing for the Netlink rt-route specification docs.
> > This is pretty essential information for working with Netlink, and I was tearing my hair out on why I couldn't find it.
> > 
> > Compare the (visible) `fixed-header` at [1] with the (absent) `fixed-header` information on [2]. The `fixed-header` key *is* present in the source yaml `Documentation/netlink/specs/rt-route.yaml` [3], but it seems it doesn't get reflected in the generated HTML version.
> > 
> > The HTML documentation would be more pleasant and useful if it had all the relevant information.
> > 
> > Thank you
> > 
> > [1]: https://www.kernel.org/doc/html/v7.4-rc1/netlink/specs/rt-link.html#operations
> > [2]: https://www.kernel.org/doc/html/v7.4-rc1/netlink/specs/rt-route.html#operations
> > [3]: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Documentation/netlink/specs/rt-route.yaml?h=v7.4-rc1#n709
> > 
> 
> -- 
> ~Randy

      reply	other threads:[~2026-11-12  3:14 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <8610ee11-e1dc-481a-9654-11188a06786a@jacobi.pw>
2026-11-12  2:16 ` Documentation suggestion on Netlink specs: missing fixed-header info Randy Dunlap
2026-11-12  3:14   ` Hangbin Liu [this message]

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=avUvDvhSnp1c-q0E@fedora \
    --to=liuhangbin@kylinos.cn \
    --cc=donald.hunter@gmail.com \
    --cc=hangbin.liu@linux.dev \
    --cc=kuba@kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=netdev@vger.kernel.org \
    --cc=pabeni@redhat.com \
    --cc=rdunlap@infradead.org \
    --cc=sigefriedhyy@gmail.com \
    --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