netdev - Re: [GIT PULL for v6.17-rc2] add a generic yaml parser integrated with Netlink specs generation

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] [thread-next>] [day] [month] [year] [list]

Message-ID: <20250812212359.6e905337@foz.lan>
Date: Tue, 12 Aug 2025 21:23:59 +0200
From: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
To: Randy Dunlap <rdunlap@...radead.org>
Cc: Jonathan Corbet <corbet@....net>, Jakub Kicinski <kuba@...nel.org>, EDAC
 Mailing List <linux-edac@...r.kernel.org>, Linux Kernel Mailing List
 <linux-kernel@...r.kernel.org>, Linux Doc Mailing List
 <linux-doc@...r.kernel.org>, Akira Yokosawa <akiyks@...il.com>, "David S.
 Miller" <davem@...emloft.net>, Ignacio Encinas Rubio
 <ignacio@...cinas.com>, Marco Elver <elver@...gle.com>, Shuah Khan
 <skhan@...uxfoundation.org>, Donald Hunter <donald.hunter@...il.com>, Eric
 Dumazet <edumazet@...gle.com>, Jan Stancek <jstancek@...hat.com>, Paolo
 Abeni <pabeni@...hat.com>, Ruben Wauters <rubenru09@....com>,
 joel@...lfernandes.org, linux-kernel-mentees@...ts.linux.dev,
 lkmm@...ts.linux.dev, netdev@...r.kernel.org, peterz@...radead.org,
 stern@...land.harvard.edu, Breno Leitao <leitao@...ian.org>, Simon Horman
 <horms@...nel.org>
Subject: Re: [GIT PULL for v6.17-rc2] add a generic yaml parser integrated
 with Netlink specs generation

On Tue, 12 Aug 2025 11:41:58 -0700
Randy Dunlap <rdunlap@...radead.org> wrote:

> On 8/12/25 11:31 AM, Jonathan Corbet wrote:
> > Mauro Carvalho Chehab <mchehab+huawei@...nel.org> writes:
> >   
> >> Hi Jon/Jakub,
> >>
> >> In case you both prefer to merge from a stable tag, please pull from:
> >>
> >> 	git://git.kernel.org/pub/scm/linux/kernel/git/mchehab/linux-docs.git docs/v6.17-1
> >>
> >> For:
> >>
> >> - An YAML parser Sphinx plugin, integrated with Netlink YAML doc
> >>   parser.  
> > 
> > OK, I have done that.  I will note that it adds a warning:
> >   
> >> Documentation/networking/netlink_spec/index.rst: WARNING: document isn't included in any toctree  
> > ...it might be nice to get that straightened out.  
> 
> I see it, at least in linux-next. However, its format is
> "different," so that may have confused whatever printed
> that message:
> 
> from Documentation/networking/index.rst:
> 
>    filter
>    generic-hdlc
>    generic_netlink
>    netlink_spec/index
>    gen_stats
>    gtp
>    ila

Maybe some merge conflict/merge issue, as this was renamed:

$ git show 1ce4da3dd99e98bd4a8b396c291041080e0fe85e Documentation/networking/index.rst
commit 1ce4da3dd99e98bd4a8b396c291041080e0fe85e
Author: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
Date:   Thu Jun 12 10:34:30 2025 +0200

    docs: use parser_yaml extension to handle Netlink specs

    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.

    Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
    Reviewed-by: Donald Hunter <donald.hunter@...il.com>

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
    gen_stats
    gtp
    ila

Thanks,
Mauro