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

2018-06-30 Thread Jonathan Corbet
On Fri, 29 Jun 2018 15:07:34 -0600
Jonathan Corbet  wrote:

> > 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 "idr synchronization" twice.
> > 
> > v3 changes:
> > * add description for empty "functions" directive to
> > Documentation/doc-guide/kernel-doc.rst  
> 
> Actually, I applied the previous set this morning...any chance you could
> send me the docs update separately?

Never mind...I realized I hadn't pushed that work, so I just switched over
to the newer version, sorry for the noise.

jon
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html


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

2018-06-29 Thread Jonathan Corbet
On Sat, 30 Jun 2018 00:05:09 +0300
Mike Rapoport  wrote:

> 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 "idr synchronization" twice.
> 
> v3 changes:
> * add description for empty "functions" directive to
> Documentation/doc-guide/kernel-doc.rst

Actually, I applied the previous set this morning...any chance you could
send me the docs update separately?

Thanks,

jon
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html


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

2018-06-29 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 "idr synchronization" twice.

v3 changes:
* add description for empty "functions" directive to
Documentation/doc-guide/kernel-doc.rst
v2 changes:
* Use empty "functions" directive instead of "nodocs", as per Jani's suggestion

Mike Rapoport (2):
  Documentation/sphinx: allow "functions" with no parameters
  docs/idr: use empty "functions" directive

 Documentation/core-api/idr.rst |  2 ++
 Documentation/doc-guide/kernel-doc.rst |  9 +++--
 Documentation/sphinx/kerneldoc.py  | 10 +++---
 3 files changed, 16 insertions(+), 5 deletions(-)

-- 
2.7.4

--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html