From: Mauro Carvalho Chehab <mchehab@s-opensource.com>
To: Jonathan Corbet <corbet@lwn.net>
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: Tue, 19 Jul 2016 21:19:08 -0300 [thread overview]
Message-ID: <20160719211908.0178aade@recife.lan> (raw)
In-Reply-To: <20160719173024.5f98da1e@lwn.net>
Em Tue, 19 Jul 2016 17:30:24 -0600
Jonathan Corbet <corbet@lwn.net> escreveu:
> On Sun, 17 Jul 2016 10:01:54 -0300
> Mauro Carvalho Chehab <mchehab@s-opensource.com> wrote:
>
> > 4) There are now several errors when parsing functions. Those seems to
> > happen when an argument is a function pointer, like:
> >
> > /devel/v4l/patchwork/Documentation/media/kapi/v4l2-core.rst:757: WARNING: Error when parsing function declaration.
> > If the function has no return type:
> > Error in declarator or parameters and qualifiers
> > Invalid definition: Expected identifier in nested name, got keyword: int [error at 3]
> > int v4l2_ctrl_add_handler (struct v4l2_ctrl_handler * hdl, struct v4l2_ctrl_handler * add, bool (*filter) (const struct v4l2_ctrl *ctrl)
> > ---^
>
> So I've been trying to reproduce this one, without success; it seems to
> work for me. As it should; the parsing code really should not have
> changed at all. Is there some particular context in which this happens
> for you?
You could pull from my tree and see it yourself:
git://linuxtv.org/media_tree.git docs-next
What I'm noticing is a series of problems when parsing some
function declarations. The number of warnings varies, depending
on the Sphinx version.
Basically, on all versions, it doesn't recognize arguments like:
bool (*filter) (const struct v4l2_ctrl *ctrl)
(this comes from kernel-doc)
Sphinx itself doesn't even recognize arguments with "enum"
on versions 1.3.x or older. With enums, it will still add it to
the book. Just the cross-reference at the index won't appear.
Thanks,
Mauro
prev parent reply other threads:[~2016-07-20 0:19 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
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 [this message]
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=20160719211908.0178aade@recife.lan \
--to=mchehab@s-opensource.com \
--cc=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 \
/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.