Re: [PATCH 4/4] docs: netlink: store generated .rst files at Documentation/output
From: Breno Leitao <leitao@debian.org>
Date: 2025-06-10 15:44:00
Also in:
linux-doc, linux-kernel-mentees, lkml
From: Breno Leitao <leitao@debian.org>
Date: 2025-06-10 15:44:00
Also in:
linux-doc, linux-kernel-mentees, lkml
Hello Mauro, On Tue, Jun 10, 2025 at 12:46:07PM +0200, Mauro Carvalho Chehab wrote:
A better long term solution is to have an extension at Documentation/sphinx that parses *.yaml files for netlink files, which could internally be calling ynl_gen_rst.py. Yet, some care needs to be taken, as yaml extensions are also used inside device tree.
In fact, This is very similar to what I did initially in v1. And I was creating a sphinx extension to handle the generation, have a look here: https://lore.kernel.org/all/20231103135622.250314-1-leitao@debian.org/ (local) During the review, we agree to move out of the sphinx extension. the reasons are the stubs/templates that needs to be created and you are creating here. So, if we decide to come back to sphinx extension, we can leverage that code from v1 ?!
-def generate_main_index_rst(output: str) -> None: +def generate_main_index_rst(output: str, index_dir: str, ) -> None:
You probably don't need the last , before ). Other than that, LGTM. The question is, are we OK with the templates that need to be created for netlink specs?! Thanks for looking at it, --breno