Re: [PATCH v3 1/2] Documentation/sphinx: allow "functions" with no parameters

2018-06-30 Thread Jonathan Corbet
On Sat, 30 Jun 2018 17:59:27 +0300 Mike Rapoport wrote: > > > > Is this the right syntax? Should we rather have: > > > > .. kernel-doc:: lib/idr.c > >:functions: * > > IMHO :functions: with no parameters is simpler. What I would really like to have there, actually, is a regex

Re: [PATCH v3 1/2] Documentation/sphinx: allow "functions" with no parameters

2018-06-30 Thread Mike Rapoport
On Sat, Jun 30, 2018 at 04:21:56AM -0700, Matthew Wilcox wrote: > On Sat, Jun 30, 2018 at 12:05:10AM +0300, Mike Rapoport wrote: > > @@ -488,14 +488,19 @@ doc: *title* > > .. kernel-doc:: drivers/gpu/drm/i915/intel_audio.c > > :doc: High Definition Audio over HDMI and Display Port > >

Re: [PATCH v3 1/2] Documentation/sphinx: allow "functions" with no parameters

2018-06-30 Thread Matthew Wilcox
On Sat, Jun 30, 2018 at 12:05:10AM +0300, Mike Rapoport wrote: > @@ -488,14 +488,19 @@ doc: *title* > .. kernel-doc:: drivers/gpu/drm/i915/intel_audio.c > :doc: High Definition Audio over HDMI and Display Port > > -functions: *function* *[...]* > +functions: *[ function ...]* >

[PATCH v3 1/2] Documentation/sphinx: allow "functions" with no parameters

2018-06-29 Thread Mike Rapoport
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"