Re: [PATCH v3] docs: kerneldoc.py: preserve headings in kernel-doc output
From: Jonathan Corbet
Date: Thu Oct 22 2026 - 12:02:31 EST
Jonathan Corbet <corbet@xxxxxxx> writes:
> Karl Mehltretter <kmehltretter@xxxxxxxxx> writes:
>
>> On Wed, Oct 14, 2026 at 11:46:13PM +0100, Mauro Carvalho Chehab wrote:
>>> On Wed, 14 Oct 2026 11:08:39 -0600
>>> Jonathan Corbet <corbet@xxxxxxx> wrote:
>>>
>>> > Which versions of Sphinx and docutils have you tested this with? I
>>> > needs to work across the full range of supported versions...
>>>
>>> The minimal docutils supported is 0.16, and the minimal Sphinx
>>> supported version is 3.4.4.
>>>
>>> You can use /tools/docs/test_doc_build.py to double check if your change
>>> is compatible with the minimal supported Sphinx/docutils versions.
>>>
>>
>> I completed the A/B matrix using tools/docs/test_doc_build.py -f. The
>> full matrix shows the improvement without a regression.
>>
>> I also tested Sphinx 9.0.0, 9.0.4, and 9.1.0, plus the previously
>> discussed Sphinx 9.1.0 / Docutils 0.21.2 pair.
>>
>> In total, this covered 32 combinations and 64 full htmldocs builds: A
>> unpatched and B patched.
>>
>> Successful, with identical A/B output and normalized diagnostics (26):
>>
>> Docutils Sphinx
>> -------- --------------------------------------------------------
>> 0.16 3.4.3, 3.5.0, 4.0.0
>> 0.17 4.1.0, 4.3.0, 4.4.0
>> 0.17.1 4.5.0, 5.0.0, 5.1.0
>> 0.18 5.2.0
>> 0.18.1 5.3.0, 6.0.0, 6.1.0, 6.1.1, 6.2.0, 7.0.0, 7.1.0
>> 0.20 7.2.6, 7.3.0
>> 0.20.1 7.4.0, 7.4.7
>> 0.21 8.0.0
>> 0.21.1 8.1.0, 8.1.3
>> 0.21.2 8.2.0, 9.1.0
>
> That seems exhaustive, thanks :)
>
> I have buttoned things up for the first 7.4 pull, but will consider this
> for later in the merge window.
Now applied, thanks.
jon