Re: [PATCH 00/14] More kernel-doc patches

[Mauro Carvalho Chehab]

On Wed, 18 Mar 2026 10:11:00 +0100
Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx> wrote:

> Hi Jon,
> 
> This series comes after:
>     https://lore.kernel.org/linux-doc/cover.1773770483.git.mchehab+huawei@xxxxxxxxxx/
> 
> It basically contains patches I submitted before on a 40+ patch series,
> but were less relevant, plus a couple of other minor fixes:
> 
> - patch 1 improves one of the CTokenizer unit test, fixing some
>   potential issues on it;
> - patches 2 and 3 contain some improvement/fixes for Sphinx
>   Python autodoc extension. They basically document c_lex.py;
> 
> - The remaining patches:
>   - create a new class for kernel-doc config;
>   - fix some internal representations of KdocItem;
>   - add unit tests for KernelDoc() parser class;
>   - add support to output KdocItem in YAML, which is a
>     machine-readable output for all documented kAPI.

Btw, if one wants, for instance, to obtain all mm-related kAPI already
documented with kernel-doc markups in a machine-readable format, all 
it is needed is to run:

	$ ./scripts/kernel-doc -none -y mm.yaml mm/ include/linux/mm.h include/linux/mm_*.h

Its output follows the YAML schema defined at:

	tools/unittests/kdoc-test-schema.yaml

Regards,
Mauro