diff options
| author | Mike Rapoport <rppt@linux.vnet.ibm.com> | 2018-06-30 00:05:10 +0300 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2018-06-30 07:52:42 -0600 |
| commit | f2e8603604aae9251d91249d8438f02234f17464 (patch) | |
| tree | 527de94d87ba6fc05431895b1f42e1e38407bd1e /Documentation/sphinx | |
| parent | dad05139541359d61ea0850a7fc5311d9ca560f0 (diff) | |
| download | linux-f2e8603604aae9251d91249d8438f02234f17464.tar.gz linux-f2e8603604aae9251d91249d8438f02234f17464.tar.bz2 linux-f2e8603604aae9251d91249d8438f02234f17464.zip | |
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>
Diffstat (limited to 'Documentation/sphinx')
| -rw-r--r-- | Documentation/sphinx/kerneldoc.py | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/Documentation/sphinx/kerneldoc.py b/Documentation/sphinx/kerneldoc.py index fbedcc39460b..9d0a7f08f93b 100644 --- a/Documentation/sphinx/kerneldoc.py +++ b/Documentation/sphinx/kerneldoc.py @@ -47,7 +47,7 @@ class KernelDocDirective(Directive): optional_arguments = 4 option_spec = { 'doc': directives.unchanged_required, - 'functions': directives.unchanged_required, + 'functions': directives.unchanged, 'export': directives.unchanged, 'internal': directives.unchanged, } @@ -75,8 +75,12 @@ class KernelDocDirective(Directive): elif 'doc' in self.options: cmd += ['-function', str(self.options.get('doc'))] elif 'functions' in self.options: - for f in str(self.options.get('functions')).split(): - cmd += ['-function', f] + functions = self.options.get('functions').split() + if functions: + for f in functions: + cmd += ['-function', f] + else: + cmd += ['-no-doc-sections'] for pattern in export_file_patterns: for f in glob.glob(env.config.kerneldoc_srctree + '/' + pattern): |