From: Jonathan Corbet <corbet@lwn.net>
To: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Cc: Markus Heiser <markus.heiser@darmarit.de>,
Linux Media Mailing List <linux-media@vger.kernel.org>,
Mauro Carvalho Chehab <mchehab@infradead.org>,
linux-doc@vger.kernel.org, Jani Nikula <jani.nikula@intel.com>
Subject: Re: Troubles with kernel-doc and RST files
Date: Sun, 17 Jul 2016 20:37:19 -0600 [thread overview]
Message-ID: <20160717203719.6471fe03@lwn.net> (raw)
In-Reply-To: <20160717100154.64823d99@recife.lan>
[Back home and trying to get going on stuff for real. I'll look at the
issues listed in this message one at a time.]
On Sun, 17 Jul 2016 10:01:54 -0300
Mauro Carvalho Chehab <mchehab@s-opensource.com> wrote:
> 1) We now need to include each header file with documentation twice,
> one to get the enums, structs, typedefs, ... and another one for the
> functions:
>
> .. kernel-doc:: include/media/media-device.h
>
> .. kernel-doc:: include/media/media-entity.h
> :export: drivers/media/media-entity.c
So I'm a little confused here; you're including from two different header
files here. Did you want media-entity.h in both directives?
If I do a simple test with a single line:
.. kernel-doc:: include/media/media-entity.h
I get everything - structs, functions, etc. - as I would expect. Are you
seeing something different?
It probably would be nice to have an option for "data structures, doc
sections, and exported functions only" at some point.
Thanks,
jon
next prev parent reply other threads:[~2016-07-18 2:37 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-07-17 13:01 Troubles with kernel-doc and RST files Mauro Carvalho Chehab
2016-07-18 2:37 ` Jonathan Corbet [this message]
2016-07-18 11:54 ` Mauro Carvalho Chehab
2016-07-19 10:00 ` Markus Heiser
2016-07-19 22:58 ` Jonathan Corbet
2016-07-20 5:32 ` Markus Heiser
2016-07-19 23:01 ` Jonathan Corbet
2016-07-20 0:08 ` Mauro Carvalho Chehab
2016-07-19 23:16 ` Jonathan Corbet
2016-07-20 0:09 ` Mauro Carvalho Chehab
2016-07-20 5:35 ` Markus Heiser
2016-07-19 23:30 ` Jonathan Corbet
2016-07-20 0:19 ` Mauro Carvalho Chehab
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=20160717203719.6471fe03@lwn.net \
--to=corbet@lwn.net \
--cc=jani.nikula@intel.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-media@vger.kernel.org \
--cc=markus.heiser@darmarit.de \
--cc=mchehab@infradead.org \
--cc=mchehab@s-opensource.com \
/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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.