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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <20250828190243.0d3f74f6@kmaincent-XPS-13-7390>
Date: Thu, 28 Aug 2025 19:02:43 +0200
From: Kory Maincent <kory.maincent@...tlin.com>
To: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
Cc: "Message-ID :" <cover.1752076293.git.mchehab+huawei@...nel.org>, Linux
 Doc Mailing List <linux-doc@...r.kernel.org>, "Akira Yokosawa"
 <akiyks@...il.com>, "Breno Leitao" <leitao@...ian.org>, "David S. Miller"
 <davem@...emloft.net>, "Donald Hunter" <donald.hunter@...il.com>, "Eric
 Dumazet" <edumazet@...gle.com>, "Ignacio Encinas Rubio"
 <ignacio@...cinas.com>, "Jakub Kicinski" <kuba@...nel.org>, "Jan Stancek"
 <jstancek@...hat.com>, "Jonathan Corbet" <corbet@....net>, "Marco Elver"
 <elver@...gle.com>, "Paolo Abeni" <pabeni@...hat.com>, "Randy Dunlap"
 <rdunlap@...radead.org>, "Ruben Wauters" <rubenru09@....com>, "Shuah Khan"
 <skhan@...uxfoundation.org>, "Simon Horman" <horms@...nel.org>,
 joel@...lfernandes.org, linux-kernel-mentees@...ts.linux.dev,
 linux-kernel@...r.kernel.org, lkmm@...ts.linux.dev, netdev@...r.kernel.org,
 peterz@...radead.org, stern@...land.harvard.edu
Subject: Re: [PATCH v10 06/14] docs: use parser_yaml extension to handle
 Netlink specs

Le Thu, 28 Aug 2025 18:50:37 +0200,
Kory Maincent <kory.maincent@...tlin.com> a écrit :

> Le Mon, 28 Jul 2025 18:01:59 +0200,
> Mauro Carvalho Chehab <mchehab+huawei@...nel.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?

Oops just saw that is was some local leftover. This first warning get removed
with a clean tree.

> 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
https://bootlin.com