Changes in test_kdoc_parser.py

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

Tue, 14 Apr 2026 17:47:08 +0200

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/unittests/test_kdoc_parser.py

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

Mon, 23 Mar 2026 10:10:50 +0100

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/unittests/test_kdoc_parser.py

3f049a5ba920f96df9eeb576d72c99535ab300f2 - unittests: test_kdoc_parser: add command line arg to read a YAML file

Mon, 23 Mar 2026 10:10:45 +0100

unittests: test_kdoc_parser: add command line arg to read a YAML fileThe test_kdoc_parser.py already supports loading dynamic testswhen running unit tests.Add support to read from a different file. This is useful for:- regression tests before/afer some changes;- preparing new unit tests;- test a different yaml before adding its contents at tools/unittests/kdoc-test.yaml.It should be noticed that passing an argument to a unit testis not too trivial, as unittest core will load itself therunner with a separate environment. The best (only?) way todo it is by setting the system environment. This way, whenthe class is called by the unit test loader, it can pickthe var from the environment without relying on a globalvariable.The unittest_helper has already provision for it, so let'suse its support.Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet Message-ID: <1d1a56de012c43756f9ca87aa9bf6c285674f113.1774256269.git.mchehab+huawei@kernel.org> List of files: /linux/tools/unittests/test_kdoc_parser.py

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

Sun, 22 Mar 2026 22:25:08 +0100

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/unittests/test_kdoc_parser.py

eea0d807dbd42b411ae0df21c6ca8d3560cb9fbf - docs: test_kdoc_parser: add support for dynamic test creation

Wed, 18 Mar 2026 10:11:12 +0100

docs: test_kdoc_parser: add support for dynamic test creationUse the content of kdoc-test.yaml to generate unittests toverify that kernel-doc internal methods are parsing C codeand generating output the expected way.Depending on what is written at the parser file atkdoc-test.yaml, up to 5 tests can be generated from a singletest entry inside the YAML file:1. from source to kdoc_item: test KernelDoc class;2. from kdoc_item to man: test ManOutput class;3. from kdoc_item to rst: test RestOutput class;4. from source to man without checking expected KdocItem;5. from source to rst without checking expected KdocItem.Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet Message-ID: <7ec2593c5b19de3e3b1d8de92675f6b751d3fa21.1773823995.git.mchehab+huawei@kernel.org> List of files: /linux/tools/unittests/test_kdoc_parser.py

a5dea56ebd35a3027628b73db0968788e99c8412 - docs: unittests: add a parser to test kernel-doc parser logic

Wed, 18 Mar 2026 10:11:09 +0100

docs: unittests: add a parser to test kernel-doc parser logicValidating that kernel-doc is parsing data properly is tricky.Add an unittest skeleton that alllows passing a source codeand check if the corresponding values of export_table andentries returned by the parser are properly filled.It works by mocking a file input with the contents of a sourcestring, an comparing if: - exports set matches; - expected KernelItem entries match.Create a new TestSelfValidate meant to check if the logicinside KdocParser.run_test() does its job of checking fordifferences inside KdocItem.Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet Message-ID: <8d91bfabd69de7aa44a0f5080ccb01aa41957e6d.1773823995.git.mchehab+huawei@kernel.org> List of files: /linux/tools/unittests/test_kdoc_parser.py