]> git.ipfire.org Git - thirdparty/kernel/linux.git/commit
docs: kdoc_files: allows the caller to use a different xforms class
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Fri, 6 Mar 2026 15:25:14 +0000 (16:25 +0100)
committerJonathan Corbet <corbet@lwn.net>
Mon, 9 Mar 2026 16:23:20 +0000 (10:23 -0600)
commit861dcdb6ad6f339a5958764352e626e2af7df4c1
tree29a4a36200514327e4186b758cebbffe8ed5e2a8
parentb8e7e03370b924f2c91895296dfb79c8692d21d4
docs: kdoc_files: allows the caller to use a different xforms class

While the main goal for kernel-doc is to be used inside the Linux
Kernel, other open source projects could benefit for it. That's
currently the case of QEMU, which has a fork, mainly due to two
reasons:

  - they need an extra C function transform rule;
  - they handle the html output a little bit different.

Add an extra optional argument to make easier for the code to be
shared, as, with that, QEMU can just create a new derivated class
that will contain its specific rulesets, and just copy the
remaining kernel-doc files as-is.

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