linux-kernel - Re: [PATCH 07/13] docs: move sphinx-pre-install to tools/doc

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: <20250814080539.2218eb4e@foz.lan>
Date: Thu, 14 Aug 2025 08:21:35 +0200
From: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
To: Jonathan Corbet <corbet@....net>
Cc: linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org, Akira Yokosawa
 <akiyks@...il.com>, Randy Dunlap <rdunlap@...radead.org>
Subject: Re: [PATCH 07/13] docs: move sphinx-pre-install to tools/doc

Em Wed, 13 Aug 2025 20:14:42 -0600
Jonathan Corbet <corbet@....net> escreveu:

> Mauro Carvalho Chehab <mchehab+huawei@...nel.org> writes:
> 
> > Em Wed, 13 Aug 2025 15:32:06 -0600
> > Jonathan Corbet <corbet@....net> escreveu:
> >  
> >> Put this tool with the other documentation-related scripts.  
> >
> > This one will be painful, as it will cause conflicts with my series
> > that clean up the docs Makefile.  
> 
> Just in general ... I'm more than happy to put this whole series on the
> back burner until we've gotten that other stuff merged ... it's an RFC
> after all, and there's no urgency here.

Ok, thanks! Yeah, this would help avoiding conflicts with the patches
I have piled here.

Btw, as I said I have a /51 patch series focused on parse-headers.pl
and kernel_include.py, which is currently used only by media docs.

For those who don't know, this was added at the very beginning of
Sphinx adoption, and had its own particular way to create *.rst
files from source code with cross references, via an specially crafted
Makefile that runs before Sphinx. This was written as a way to detect
uAPI documentation gaps, producing warnings for unsolved cross references.
Recent Sphinx versions broke it by disabling cross-reference warnings.

This series is big (51 patches) because it needs to fix thousands of
broken cross references on media. I may end splitting it on two series
to make easier for review, one for the script and another for media doc
fixes.

Such series affect this RFC as it is creating a tools/docs and placing 
there the parse-headers.py code as:

	 tools/docs/lib/parse_data_structs.py                                  |  230 +++++++++++++++--------------------
	 tools/docs/parse-headers.py                                           |    5 

Now, if you prefer tools/doc instead and/or place the libs elsewhere,
we have a couple of options:

1. rebase my series to do the changes. I suspect that there won't
   be much conflicts, but this may delay a little bit sending you
   what I have;

2. add a patch at the end moving stuff elsewhere;

3. on your series, move them elsewhere.

What do you prefer?

Thanks,
Mauro