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

2018-06-18 Thread Mike Rapoport
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 was explictly > > included in the same document

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

2018-06-18 Thread Jani Nikula
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 was explictly > included in the same document it will be duplicated. For example, the > output generated for

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

2018-06-18 Thread Matthew Wilcox
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: sections when "kernel-doc:" directive > is used without explicit selection of

[PATCH 2/2] docs/idr: use "nodocs" directive

2018-06-18 Thread Mike Rapoport
to avoid duplication of DOC: sections in the middle of the API reference. Signed-off-by: Mike Rapoport --- 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 9078a5c..15eadf8 100644 ---

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

2018-06-18 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

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

2018-06-18 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 explictly included in the same document it will be duplicated. For example, the output generated for Documentation/core-api/idr.rst [1] has "IDA description"