[PATCH v2 2/2] docs/idr: use empty "functions" directive

2018-06-19 Thread Mike Rapoport
to avoid duplication of DOC: sections in the middle of the API reference. Signed-off-by: Mike Rapoport Acked-by: Matthew Wilcox --- Documentation/core-api/idr.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Documentation/core-api/idr.rst b/Documentation/core-api/idr.rst index

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

2018-06-19 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"

[PATCH v2 0/2] Documentation/sphinx: add kind of "nodocs" directive

2018-06-19 Thread Mike Rapoport
Hi, These patches allow passing "-no-doc-sections" option to scripts/kernel-doc from the sphinx generator. This allows to avoid duplicated DOC: sections when "kernel-doc:" directive is used without explicit selection of functions or function types. For instance, [1] has "IDA description" and

Re: [PATCH 0/2] Documentation/sphinx: add "nodocs" directive

2018-06-19 Thread Mike Rapoport
On Tue, Jun 19, 2018 at 07:11:56AM -0700, Matthew Wilcox wrote: > On Mon, Jun 18, 2018 at 10:10:28AM -0700, Matthew Wilcox wrote: > > On Mon, Jun 18, 2018 at 04:36:34PM +0300, Mike Rapoport wrote: > > > Hi, > > > > > > These patches allow passing "-no-doc-sections" option to > > >

Re: [PATCH 0/2] Documentation/sphinx: add "nodocs" directive

2018-06-19 Thread Matthew Wilcox
On Mon, Jun 18, 2018 at 10:10:28AM -0700, Matthew Wilcox wrote: > On Mon, Jun 18, 2018 at 04:36:34PM +0300, Mike Rapoport wrote: > > Hi, > > > > These patches allow passing "-no-doc-sections" option to scripts/kernel-doc > > from the sphinx generator. > > > > This allows to avoid duplicated DOC:

Re: [PATCH 1/2] Documentation/sphinx: add "nodocs" directive

2018-06-19 Thread Mike Rapoport
On Tue, Jun 19, 2018 at 11:09:42AM +0300, Jani Nikula wrote: > On Tue, 19 Jun 2018, Mike Rapoport wrote: > > On Tue, Jun 19, 2018 at 10:29:20AM +0300, Jani Nikula wrote: > >> On Tue, 19 Jun 2018, Mike Rapoport wrote: > >> > On Mon, Jun 18, 2018 at 11:01:32PM +0300, Jani Nikula wrote: > >> >> On

Re: [PATCH 1/2] Documentation/sphinx: add "nodocs" directive

2018-06-19 Thread Jani Nikula
On Tue, 19 Jun 2018, Mike Rapoport wrote: > On Tue, Jun 19, 2018 at 10:29:20AM +0300, Jani Nikula wrote: >> On Tue, 19 Jun 2018, Mike Rapoport wrote: >> > On Mon, Jun 18, 2018 at 11:01:32PM +0300, Jani Nikula wrote: >> >> On Mon, 18 Jun 2018, Mike Rapoport wrote: >> >> > When kernel-doc::

Re: [PATCH 1/2] Documentation/sphinx: add "nodocs" directive

2018-06-19 Thread Mike Rapoport
On Tue, Jun 19, 2018 at 10:29:20AM +0300, Jani Nikula wrote: > On Tue, 19 Jun 2018, Mike Rapoport wrote: > > On Mon, Jun 18, 2018 at 11:01:32PM +0300, Jani Nikula wrote: > >> On Mon, 18 Jun 2018, Mike Rapoport wrote: > >> > When kernel-doc:: specified in .rst document without explicit

Re: [PATCH 1/2] Documentation/sphinx: add "nodocs" directive

2018-06-19 Thread Jani Nikula
On Tue, 19 Jun 2018, Mike Rapoport wrote: > On Mon, Jun 18, 2018 at 11:01:32PM +0300, Jani Nikula wrote: >> On Mon, 18 Jun 2018, Mike Rapoport wrote: >> > When kernel-doc:: specified in .rst document without explicit directives, >> > it outputs both comment and DOC: sections. If a DOC: section