netdev - Re: [PATCH v8 06/13] 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] [thread-next>] [day] [month] [year] [list]

Message-ID: <m2wm8x8omf.fsf@gmail.com>
Date: Fri, 27 Jun 2025 11:28:40 +0100
From: Donald Hunter <donald.hunter@...il.com>
To: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
Cc: Linux Doc Mailing List <linux-doc@...r.kernel.org>,  Jonathan Corbet
 <corbet@....net>,  "Akira Yokosawa" <akiyks@...il.com>,  "Breno Leitao"
 <leitao@...ian.org>,  "David S. Miller" <davem@...emloft.net>,  "Eric
 Dumazet" <edumazet@...gle.com>,  "Ignacio Encinas Rubio"
 <ignacio@...cinas.com>,  "Jan Stancek" <jstancek@...hat.com>,  "Marco
 Elver" <elver@...gle.com>,  "Paolo Abeni" <pabeni@...hat.com>,  "Randy
 Dunlap" <rdunlap@...radead.org>,  "Ruben Wauters" <rubenru09@....com>,
  "Shuah Khan" <skhan@...uxfoundation.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 v8 06/13] docs: use parser_yaml extension to handle
 Netlink specs

Mauro Carvalho Chehab <mchehab+huawei@...nel.org> writes:

> 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>

This patch doesn't currently merge in the net-next tree because it
depends on a series in docs-next.

> diff --git a/Documentation/sphinx/parser_yaml.py b/Documentation/sphinx/parser_yaml.py
> index 585a7ec81ba0..fa2e6da17617 100755
> --- a/Documentation/sphinx/parser_yaml.py
> +++ b/Documentation/sphinx/parser_yaml.py
> @@ -18,9 +18,9 @@ from sphinx.util import logging
>  from sphinx.parsers import Parser
>  
>  srctree = os.path.abspath(os.environ["srctree"])
> -sys.path.insert(0, os.path.join(srctree, "tools/net/ynl/pyynl"))
> +sys.path.insert(0, os.path.join(srctree, "tools/net/ynl/pyynl/lib"))
>  
> -from netlink_yml_parser import YnlDocGenerator        # pylint: disable=C0413
> +from doc_generator import YnlDocGenerator        # pylint: disable=C0413

Please fix up patch 5 so that this diff can be dropped.