netdev - Re: [PATCH v9 05/13] docs: sphinx: add a parser for yaml files for 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: <m24ivk78ng.fsf@gmail.com>
Date: Thu, 10 Jul 2025 09:27:31 +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 v9 05/13] docs: sphinx: add a parser for yaml files for
 Netlink specs

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

> Add a simple sphinx.Parser to handle yaml files and add the
> the code to handle Netlink specs. All other yaml files are
> ignored.
>
> The code was written in a way that parsing yaml for different
> subsystems and even for different parts of Netlink are easy.
>
> All it takes to have a different parser is to add an
> import line similar to:
>
> 	from doc_generator import YnlDocGenerator
>
> adding the corresponding parser somewhere at the extension:
>
> 	netlink_parser = YnlDocGenerator()
>
> And then add a logic inside parse() to handle different
> doc outputs, depending on the file location, similar to:
>
>         if "/netlink/specs/" in fname:
>             msg = self.netlink_parser.parse_yaml_file(fname)
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>

Reviewed-by: Donald Hunter <donald.hunter@...il.com>