]> git.ipfire.org Git - thirdparty/kernel/linux.git/commit
docs: add a simple kdoc-test.yaml together with a validation tool
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Wed, 18 Mar 2026 09:11:11 +0000 (10:11 +0100)
committerJonathan Corbet <corbet@lwn.net>
Sun, 22 Mar 2026 21:10:40 +0000 (15:10 -0600)
commit8b69f5225aebbe37c767021bee1b95642ce530ca
tree0c1134567c5402d6e1c1fe45f075b396bbed05f7
parentf1cdbd824ca74e464a6159a0ae8af3ab1f123900
docs: add a simple kdoc-test.yaml together with a validation tool

Create a simple kdoc-test.yaml to be used to create unit tests for
kernel-doc parser and output classes.

For now, all we want is a simple function mapped on a yaml test
using the defined schema.

To be sure that the schema is followed, add an unittest for
the file, which will also validate that the schema is properly
parsed.

It should be noticed that the .TH definition for the man format
contains a timestamp. We'll need to handle that when dealing with
the actual implementation for the ManOutput class unit tests.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <74883976348c964f00161696d525c33ddd8c7641.1773823995.git.mchehab+huawei@kernel.org>
tools/unittests/kdoc-test.yaml [new file with mode: 0644]
tools/unittests/test_kdoc_test_schema.py [new file with mode: 0755]