]> git.baikalelectronics.ru Git - kernel.git/commit
Documentation/sphinx: allow "functions" with no parameters
authorMike Rapoport <rppt@linux.vnet.ibm.com>
Fri, 29 Jun 2018 21:05:10 +0000 (00:05 +0300)
committerJonathan Corbet <corbet@lwn.net>
Sat, 30 Jun 2018 13:52:42 +0000 (07:52 -0600)
commitbde68bba1455f402ee6c5b0ce3335272cd6ca8fc
tree527de94d87ba6fc05431895b1f42e1e38407bd1e
parentece7b801f5b1ee28b035a8cabb9583eeabcba99a
Documentation/sphinx: allow "functions" with no parameters

When kernel-doc:: specified in .rst document without explicit directives,
it outputs both comment and DOC: sections. If a DOC: section was explicitly
included in the same document it will be duplicated. For example, the
output generated for Documentation/core-api/idr.rst [1] has "IDA
description" in the "IDA usage" section and in the middle of the API
reference.

This patch enables using "functions" directive without parameters to output
all the documentation excluding DOC: sections.

[1] https://www.kernel.org/doc/html/v4.17/core-api/idr.html

Signed-off-by: Mike Rapoport <rppt@linux.vnet.ibm.com>
Acked-by: Matthew Wilcox <willy@infradead.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/doc-guide/kernel-doc.rst
Documentation/sphinx/kerneldoc.py