Changes in kdoc_yaml_file.py

5181afcdf99527dd92a88f80fc4d0d8013e1b510 - Merge tag 'docs-7.1' of git://git.kernel.org/pub/scm/linux/kernel/git/docs/linux

Tue, 14 Apr 2026 15:47:08 +0000

Merge tag 'docs-7.1' of git://git.kernel.org/pub/scm/linux/kernel/git/docs/linuxPull documentation updates from Jonathan Corbet: "A busier cycle than I had expected for docs, including: - Translations: some overdue updates to the Japanese translations, Chinese translations for some of the Rust documentation, and the beginnings of a Portuguese translation. - New documents covering CPU isolation, managed interrupts, debugging Python gbb scripts, and more. - More tooling work from Mauro, reducing docs-build warnings, adding self tests, improving man-page output, bringing in a proper C tokenizer to replace (some of) the mess of kernel-doc regexes, and more. - Update and synchronize changes.rst and scripts/ver_linux, and put both into alphabetical order. ... and a long list of documentation updates, typo fixes, and general improvements"* tag 'docs-7.1' of git://git.kernel.org/pub/scm/linux/kernel/git/docs/linux: (162 commits) Documentation: core-api: real-time: correct spelling doc: Add CPU Isolation documentation Documentation: Add managed interrupts Documentation: seq_file: drop 2.6 reference docs/zh_CN: update rust/index.rst translation docs/zh_CN: update rust/quick-start.rst translation docs/zh_CN: update rust/coding-guidelines.rst translation docs/zh_CN: update rust/arch-support.rst translation docs/zh_CN: sync process/2.Process.rst with English version docs/zh_CN: fix an inconsistent statement in dev-tools/testing-overview tracing: Documentation: Update histogram-design.rst for fn() handling docs: sysctl: Add documentation for /proc/sys/xen/ Docs: hid: intel-ish-hid: make long URL usable Documentation/kernel-parameters: fix architecture alignment for pt, nopt, and nobypass sched/doc: Update yield_task description in sched-design-CFS Documentation/rtla: Convert links to RST format docs: fix typos and duplicated words across documentation docs: fix typo in zoran driver documentation docs: add an Assisted-by mention to submitting-patches.rst Revert "scripts/checkpatch: add Assisted-by: tag validation" ... List of files: /linux/tools/lib/python/kdoc/kdoc_yaml_file.py

e786fab2cfcc9ab65adf35d2eab4ca94abe1955f - docs: kdoc_yaml_file: use a better name for the tests

Mon, 23 Mar 2026 09:10:51 +0000

docs: kdoc_yaml_file: use a better name for the testsInstead of always using a name with a number on it, usethe name of the object directly whenever possible.When the name is already used, append a number prefix atthe end.Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet Message-ID: List of files: /linux/tools/lib/python/kdoc/kdoc_yaml_file.py

99ec67a9984fdf38c7ed78695aeb1b99cfee5b50 - docs: kdoc: better handle source when producing YAML output

Mon, 23 Mar 2026 09:10:50 +0000

docs: kdoc: better handle source when producing YAML outputThe current logic was storing symbols source code on a list,not linked to the actual KdocItem. While this works fine whenkernel-doc markups are OK, on places where there is a "/**"without a valid kernel-doc markup, it ends that the 1:1 matchbetween source code and KdocItem doesn't happen, causingproblems to generate the YAML output.Fix it by storing the source code directly into the KdocItemstructure.This shouldn't affect performance or memory footprint, exceptwhen --yaml option is used.While here, add a __repr__() function for KdocItem, as ithelps debugging it.Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet Message-ID: <77902dafabb5c3250486aa2dc1568d5fafa95c5b.1774256269.git.mchehab+huawei@kernel.org> List of files: /linux/tools/lib/python/kdoc/kdoc_yaml_file.py

6e0d7b63676b85490bbaf01c9a8ebcd692bed981 - docs: kdoc_yaml_file: add a representer to make strings look nicer

Mon, 23 Mar 2026 09:10:47 +0000

docs: kdoc_yaml_file: add a representer to make strings look nicerThe strings representation is not ok, currently. Add a helperfunction to improve it, and drop blank lines at beginning andat the end of the dumpsSigned-off-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet Message-ID: <422041a8b49b2609de5749092fe074b7948c32a6.1774256269.git.mchehab+huawei@kernel.org> List of files: /linux/tools/lib/python/kdoc/kdoc_yaml_file.py

0a1a27776ddf0072883cdb4a61b91155553fcb96 - Merge branch 'mauro' into docs-mw

Sun, 22 Mar 2026 21:25:08 +0000

Merge branch 'mauro' into docs-mwThis series comes after: https://lore.kernel.org/linux-doc/cover.1773770483.git.mchehab+huawei@kernel.org/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.None of the patches should affect man or html output. List of files: /linux/tools/lib/python/kdoc/kdoc_yaml_file.py

b37b3cbbb1f1a99bc8b95d9f00fcf887c27f4770 - docs: add a new file to write kernel-doc output to a YAML file

Wed, 18 Mar 2026 09:11:13 +0000

docs: add a new file to write kernel-doc output to a YAML fileStoring kernel-doc output is helpful to allow debugging problemson it and to preparate unit tests.Add a class to store such contents at the same format as definedat kdoc-test-schema.yaml.Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet Message-ID: <5d084ca1a91f6a620534a1135d1b8183d934319a.1773823995.git.mchehab+huawei@kernel.org> List of files: /linux/tools/lib/python/kdoc/kdoc_yaml_file.py