]> git.ipfire.org Git - thirdparty/linux.git/commit
docs: kdoc: better handle source when producing YAML output
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Mon, 23 Mar 2026 09:10:50 +0000 (10:10 +0100)
committerJonathan Corbet <corbet@lwn.net>
Wed, 25 Mar 2026 19:36:46 +0000 (13:36 -0600)
commit99ec67a9984fdf38c7ed78695aeb1b99cfee5b50
treeb00e5dc56d43ec03b1e63441e4e14badc6ec9f73
parent8326e4a21838593fe67b5d79ba6d0dc8e962ebb9
docs: kdoc: better handle source when producing YAML output

The current logic was storing symbols source code on a list,
not linked to the actual KdocItem. While this works fine when
kernel-doc markups are OK, on places where there is a "/**"
without a valid kernel-doc markup, it ends that the 1:1 match
between source code and KdocItem doesn't happen, causing
problems to generate the YAML output.

Fix it by storing the source code directly into the KdocItem
structure.

This shouldn't affect performance or memory footprint, except
when --yaml option is used.

While here, add a __repr__() function for KdocItem, as it
helps debugging it.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <77902dafabb5c3250486aa2dc1568d5fafa95c5b.1774256269.git.mchehab+huawei@kernel.org>
tools/lib/python/kdoc/kdoc_files.py
tools/lib/python/kdoc/kdoc_item.py
tools/lib/python/kdoc/kdoc_parser.py
tools/lib/python/kdoc/kdoc_yaml_file.py
tools/unittests/test_kdoc_parser.py