Re: [PATCH v10 06/14] docs: use parser_yaml extension to handle Netlink specs

Kory Maincent
2025-08-28T16:51:24Z

Le Mon, 28 Jul 2025 18:01:59 +0200,
Mauro Carvalho Chehab <mchehab+huawei@kernel.org> a écrit :

> Instead of manually calling ynl_gen_rst.py, use a Sphinx extension.
> This way, no .rst files would be written to the Kernel source
> directories.
>
> We are using here a toctree with :glob: property. This way, there
> is no need to touch the netlink/specs/index.rst file every time
> a new Netlink spec is added/renamed/removed.

...

> diff --git a/Documentation/networking/index.rst
> b/Documentation/networking/index.rst index ac90b82f3ce9..b7a4969e9bc9 100644
> --- a/Documentation/networking/index.rst
> +++ b/Documentation/networking/index.rst
> @@ -57,7 +57,7 @@ Contents:
> filter
> generic-hdlc
> generic_netlink
> - netlink_spec/index
> + ../netlink/specs/index

Faced a doc build warning that say netlink_spec/index.rst is not used.

$ git grep netlink_spec
Documentation/networking/mptcp.rst:netlink_spec/mptcp_pm.rst.
Documentation/translations/zh_CN/networking/index.rst:* netlink_spec/index

I think we can remove the whole directory and change these, right?

Also got a doc build warning that says netlink/specs/index is not existing even
if it exists. Maybe a sphinx parsing issue ?!

Regards,
--
Köry Maincent, Bootlin
Embedded Linux and kernel engineering