]> git.ipfire.org Git - thirdparty/kernel/linux.git/commit
docs: kernel_include.py: add support to generate a TOC table
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Fri, 22 Aug 2025 14:19:29 +0000 (16:19 +0200)
committerJonathan Corbet <corbet@lwn.net>
Fri, 29 Aug 2025 21:54:43 +0000 (15:54 -0600)
commite4d91787deffffa64abd397315d4f7e4a3cf02f3
tree23ae97643aa8071a1ac2b35f5dff4319cd0a1919
parent9be2a5c3c8b7aad78341677002c428c996cc9570
docs: kernel_include.py: add support to generate a TOC table

When generate-cross-refs is used, instead of just implementing
the default of generating a literal block, we can also
generate a ReST file as a TOC.

The advantage is that, by being a ReST file, missing references
will point to the place inside the header file that has the
broken link.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/c0d32cd1ef94017e05984b0a38bd2516f7db21e2.1755872208.git.mchehab+huawei@kernel.org
Documentation/sphinx/kernel_include.py