]> git.ipfire.org Git - thirdparty/kernel/linux.git/commit
docs: kdoc_files: document KernelFiles() ABI
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Fri, 6 Mar 2026 15:25:15 +0000 (16:25 +0100)
committerJonathan Corbet <corbet@lwn.net>
Mon, 9 Mar 2026 16:23:20 +0000 (10:23 -0600)
commit0d3ab0e4bbfd688bfaef66b6365a71c70a0f0450
tree96ae26ca04b1ff91e01908c4b4a77706a6c7e24c
parent861dcdb6ad6f339a5958764352e626e2af7df4c1
docs: kdoc_files: document KernelFiles() ABI

The KernelFiles is the main entry point to run kernel-doc,
being used by both tools/docs/kernel-doc and
Documentation/sphinx/kerneldoc.py.

It is also used on QEMU, which also uses the kernel-doc
libraries from tools/lib/python/kdoc.

Properly describe its ABI contract.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <13eb44c341232564eaf2a9c9de4782369fef57e1.1772810574.git.mchehab+huawei@kernel.org>
tools/lib/python/kdoc/kdoc_files.py