From: Jonathan Corbet <corbet@lwn.net>
To: Jani Nikula <jani.nikula@intel.com>
Cc: Markus Heiser <markus.heiser@darmarit.de>,
Daniel Vetter <daniel.vetter@ffwll.ch>,
Grant Likely <grant.likely@secretlab.ca>,
Mauro Carvalho Chehab <mchehab@osg.samsung.com>,
Dan Allen <dan@opendevise.io>,
Russel Winder <russel@winder.org.uk>,
Keith Packard <keithp@keithp.com>,
LKML <linux-kernel@vger.kernel.org>,
linux-doc@vger.kernel.org, Hans Verkuil <hverkuil@xs4all.nl>
Subject: Re: [PATCH 05/10] Documentation/sphinx: add Sphinx kernel-doc directive extension
Date: Fri, 3 Jun 2016 14:35:36 -0600 [thread overview]
Message-ID: <20160603143536.194ff752@lwn.net> (raw)
In-Reply-To: <d78019feb5a4561329d77b26de1773e0478c5ef6.1463748027.git.jani.nikula@intel.com>
On Fri, 20 May 2016 16:39:36 +0300
Jani Nikula <jani.nikula@intel.com> wrote:
> Add an extension to handle kernel-doc directives, to call kernel-doc
> according to the arguments and parameters given to the reStructuredText
> directive.
>
> The syntax for the kernel-doc directive is:
>
> .. kernel-doc:: FILENAME
> :export:
> :internal:
> :functions: FUNCTION [FUNCTION ...]
> :doc: SECTION TITLE
So this seems just like what the doctor ordered - nice!
One little thought that has crossed my mind: it might be nice to be able to
put a regex in :functions: so we could say something like:
:functions: atomic_.*
That requires a kernel-doc tweak too, of course. Someday.
Might it be worth running this by the Sphinx list just to see what they
have to say?
jon
next prev parent reply other threads:[~2016-06-03 20:35 UTC|newest]
Thread overview: 45+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-05-20 13:39 [PATCH 00/10] Documentation/Sphinx Jani Nikula
2016-05-20 13:39 ` [PATCH 01/10] kernel-doc: fix use of uninitialized value Jani Nikula
2016-05-20 13:39 ` [PATCH 02/10] kernel-doc: support printing exported and non-exported symbols Jani Nikula
2016-05-20 13:39 ` [PATCH 03/10] Documentation/sphinx: add basic working Sphinx configuration and build Jani Nikula
2016-05-20 13:39 ` [PATCH 04/10] Documentation: add .gitignore Jani Nikula
2016-05-20 13:39 ` [PATCH 05/10] Documentation/sphinx: add Sphinx kernel-doc directive extension Jani Nikula
2016-06-03 20:35 ` Jonathan Corbet [this message]
2016-06-04 6:57 ` Markus Heiser
2016-05-20 13:39 ` [PATCH 06/10] Documentation/sphinx: configure the kernel-doc extension Jani Nikula
2016-05-20 13:39 ` [PATCH 07/10] sphinx: cheesy script to convert .tmpl files Jani Nikula
2016-05-20 13:39 ` [PATCH 08/10] Documentation: add kernel hacking rst Jani Nikula
2016-05-20 13:39 ` [PATCH 09/10] Documentation: add kernel api rst Jani Nikula
2016-05-20 13:39 ` [PATCH 10/10] Documentation: moar files Jani Nikula
2016-05-29 20:33 ` [PATCH 00/10] Documentation/Sphinx Jani Nikula
2016-05-30 9:10 ` Daniel Vetter
2016-05-30 10:47 ` Markus Heiser
2016-05-30 14:46 ` Jani Nikula
2016-05-30 15:29 ` Daniel Vetter
2016-05-30 16:39 ` Markus Heiser
2016-05-30 20:05 ` Jani Nikula
2016-05-30 21:23 ` Mauro Carvalho Chehab
2016-05-31 10:16 ` Markus Heiser
2016-06-24 10:40 ` Mauro Carvalho Chehab
2016-06-27 6:15 ` Markus Heiser
2016-06-27 17:08 ` Mauro Carvalho Chehab
2016-06-29 12:41 ` Markus Heiser
2016-05-31 7:27 ` Markus Heiser
2016-05-31 8:07 ` Daniel Vetter
2016-05-31 9:39 ` Markus Heiser
2016-05-31 10:30 ` Jani Nikula
2016-05-31 11:12 ` Markus Heiser
2016-06-03 20:47 ` rst2pdf (was [PATCH 00/10] Documentation/Sphinx) Jonathan Corbet
2016-06-07 6:02 ` Markus Heiser
2016-06-07 6:44 ` Jani Nikula
2016-06-10 17:08 ` Markus Heiser
2016-06-03 21:04 ` [PATCH 00/10] Documentation/Sphinx Jonathan Corbet
2016-06-03 22:54 ` Daniel Vetter
2016-06-04 11:45 ` Jani Nikula
2016-06-01 1:07 ` Jonathan Corbet
2016-06-01 6:42 ` Daniel Vetter
2016-06-03 20:16 ` Jonathan Corbet
2016-06-03 20:24 ` Daniel Vetter
2016-06-03 20:27 ` Jonathan Corbet
2016-06-04 13:01 ` Jani Nikula
2016-06-04 12:54 ` Jani Nikula
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=20160603143536.194ff752@lwn.net \
--to=corbet@lwn.net \
--cc=dan@opendevise.io \
--cc=daniel.vetter@ffwll.ch \
--cc=grant.likely@secretlab.ca \
--cc=hverkuil@xs4all.nl \
--cc=jani.nikula@intel.com \
--cc=keithp@keithp.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=markus.heiser@darmarit.de \
--cc=mchehab@osg.samsung.com \
--cc=russel@winder.org.uk \
/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