Linux Documentation
 help / color / mirror / Atom feed
* Documentation suggestion on Netlink specs: missing fixed-header info
@ 2026-11-05 10:48 Wessel Jacobi
  2026-11-12  2:16 ` Randy Dunlap
  0 siblings, 1 reply; 3+ messages in thread
From: Wessel Jacobi @ 2026-11-05 10:48 UTC (permalink / raw)
  To: linux-doc


[-- Attachment #1.1: Type: text/plain, Size: 1219 bytes --]

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

-- 
Met vriendelijke groeten,
Wessel Jacobi
https://www.jacobi.pw

------------------------------
I prefer to use encrypted email. My public GPG key fingerprint is 6092 
B1AB 7F60 AB78 000A 8331 FC3A A544 BE58 F812 and the key is available at 
https://www.jacobi.pw/pgp.txt


[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 236 bytes --]

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: Documentation suggestion on Netlink specs: missing fixed-header info
  2026-11-05 10:48 Documentation suggestion on Netlink specs: missing fixed-header info Wessel Jacobi
@ 2026-11-12  2:16 ` Randy Dunlap
  2026-11-12  3:14   ` Hangbin Liu
  0 siblings, 1 reply; 3+ messages in thread
From: Randy Dunlap @ 2026-11-12  2:16 UTC (permalink / raw)
  To: Wessel Jacobi, linux-doc
  Cc: Hangbin Liu, Jakub Kicinski, Linux Networking, Paolo Abeni,
	Yuyang Huang, Donald Hunter

Hi netdev:

Does anyone know what this means and what to do about it?
Thanks.

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


^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: Documentation suggestion on Netlink specs: missing fixed-header info
  2026-11-12  2:16 ` Randy Dunlap
@ 2026-11-12  3:14   ` Hangbin Liu
  0 siblings, 0 replies; 3+ messages in thread
From: Hangbin Liu @ 2026-11-12  3:14 UTC (permalink / raw)
  To: Randy Dunlap
  Cc: Wessel Jacobi, linux-doc, Jakub Kicinski, Hangbin Liu,
	Linux Networking, Paolo Abeni, Yuyang Huang, Donald Hunter

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

^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2026-11-12  3:14 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-11-05 10:48 Documentation suggestion on Netlink specs: missing fixed-header info Wessel Jacobi
2026-11-12  2:16 ` Randy Dunlap
2026-11-12  3:14   ` Hangbin Liu

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox