From: Mike Rapoport <rppt@linux.vnet.ibm.com>
To: Jonathan Corbet <corbet@lwn.net>
Cc: Matthew Wilcox <willy@infradead.org>,
Jani Nikula <jani.nikula@intel.com>,
linux-doc <linux-doc@vger.kernel.org>,
Mike Rapoport <rppt@linux.vnet.ibm.com>
Subject: [PATCH v2 0/2] Documentation/sphinx: add kind of "nodocs" directive
Date: Wed, 20 Jun 2018 07:21:07 +0300 [thread overview]
Message-ID: <1529468469-10088-1-git-send-email-rppt@linux.vnet.ibm.com> (raw)
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.
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/sphinx/kerneldoc.py | 10 +++++++---
2 files changed, 9 insertions(+), 3 deletions(-)
--
2.7.4
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
next reply other threads:[~2018-06-20 4:21 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-06-20 4:21 Mike Rapoport [this message]
2018-06-20 4:21 ` [PATCH v2 1/2] Documentation/sphinx: allow "functions" with no parameters Mike Rapoport
2018-06-20 7:19 ` Jani Nikula
2018-06-20 8:49 ` Mike Rapoport
2018-06-26 14:59 ` Jonathan Corbet
2018-06-20 4:21 ` [PATCH v2 2/2] docs/idr: use empty "functions" directive Mike Rapoport
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1529468469-10088-1-git-send-email-rppt@linux.vnet.ibm.com \
--to=rppt@linux.vnet.ibm.com \
--cc=corbet@lwn.net \
--cc=jani.nikula@intel.com \
--cc=linux-doc@vger.kernel.org \
--cc=willy@infradead.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox