On Wed, Jun 20, 2018 at 10:19:36AM +0300, Jani Nikula wrote: > On Wed, 20 Jun 2018, Mike Rapoport <rppt@xxxxxxxxxxxxxxxxxx> wrote: > > 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@xxxxxxxxxxxxxxxxxx> > > Acked-by: Matthew Wilcox <willy@xxxxxxxxxxxxx> > > Looks good to me. Though I do realize now that I overlooked that this > applies to not only functions, but also to other non-DOC documentation > comments. I guess up to Jon to decide. We can name it "everything-except-doc-sections" ;-) > Please do give the cobbler's children some shoes, and document this in > Documentation/doc-guide/kernel-doc.rst. Sure. I'd just wait until there's consensus on the name :) > Thanks, > Jani. > > > --- > > Documentation/sphinx/kerneldoc.py | 10 +++++++--- > > 1 file changed, 7 insertions(+), 3 deletions(-) > > > > diff --git a/Documentation/sphinx/kerneldoc.py b/Documentation/sphinx/kerneldoc.py > > index fbedcc3..9d0a7f0 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): > > -- > Jani Nikula, Intel Open Source Graphics Center > -- Sincerely yours, Mike. -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html
