From: Stephen Rothwell <sfr@canb.auug.org.au>
To: Marc Zyngier <maz@kernel.org>
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>,
Linus Walleij <linus.walleij@linaro.org>,
Jonathan Corbet <corbet@lwn.net>, Joey Gouly <joey.gouly@arm.com>,
Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
Linux Next Mailing List <linux-next@vger.kernel.org>
Subject: Re: linux-next: build warning after merge of the pinctrl tree
Date: Thu, 20 Jan 2022 14:25:39 +1100 [thread overview]
Message-ID: <20220120142539.6d1fac12@canb.auug.org.au> (raw)
In-Reply-To: <20211028080331.6d199082@sal.lan>
[-- Attachment #1: Type: text/plain, Size: 2296 bytes --]
Hi all,
On Thu, 28 Oct 2021 08:03:31 +0100 Mauro Carvalho Chehab <mchehab@kernel.org> wrote:
>
> Em Wed, 27 Oct 2021 12:10:45 +0100
> Marc Zyngier <maz@kernel.org> escreveu:
>
> > On Wed, 27 Oct 2021 12:01:18 +0100, Stephen Rothwell <sfr@canb.auug.org.au> wrote:
> > >
> > > After merging the pinctrl tree, today's linux-next build (htmldocs)
> > > produced this warning:
> > >
> > > include/linux/gpio/driver.h:284: warning: Function parameter or member 'parent_handler_data_array' not described in 'gpio_irq_chip'
> > >
> > > Introduced by commit
> > >
> > > cfe6807d82e9 ("gpio: Allow per-parent interrupt data")
> > >
> > > But may actually be a problem with the tool :-(
> >
> > I guess the tool doesn't like having two fields that are part of a
> > union documented together... Happy to tweak it if someone tells me how
> > this should be written.
>
> Yes, that's the case. See, when you do:
>
> /**
> * @parent_handler_data:
> * @parent_handler_data_array:
> *
> * Data associated, and passed to, the handler for the parent
> * interrupt. Can either be a single pointer if @per_parent_data
> * is false, or an array of @num_parents pointers otherwise. If
> * @per_parent_data is true, @parent_handler_data_array cannot be
> * NULL.
> */
> union {
> void *parent_handler_data;
> void **parent_handler_data_array;
> };
>
> The tool will understand it as an undocumented "parent_handler_data" and
> a documented "parent_handler_data_array".
>
> It has to do that, as otherwise it won't get cases where people just adds a
> @foo: as a template but actually forgets to fill it.
>
> The solution would be to add a description for both, e. g. something
> similar to:
>
> /**
> * @parent_handler_data:
> *
> * If @per_parent_data is false, contains a single pointer
> * with the data associated, and passed to, the handler for the
> * parent interrupt.
> *
> * @parent_handler_data_array:
> *
> * If @per_parent_data is true, it should contain an array of
> * @num_parents pointers with the data associated, and passed to,
> * the handler for the parent interrupt. Cannot be NULL.
> */
I am still getting this warning.
--
Cheers,
Stephen Rothwell
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]
next prev parent reply other threads:[~2022-01-20 3:25 UTC|newest]
Thread overview: 25+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-10-27 11:01 linux-next: build warning after merge of the pinctrl tree Stephen Rothwell
2021-10-27 11:10 ` Marc Zyngier
2021-10-28 7:03 ` Mauro Carvalho Chehab
2022-01-20 3:25 ` Stephen Rothwell [this message]
2022-03-18 7:31 ` Stephen Rothwell
2022-06-05 23:33 ` Stephen Rothwell
-- strict thread matches above, loose matches on Subject: below --
2022-04-21 7:11 Stephen Rothwell
2022-04-21 14:12 ` Linus Walleij
2022-04-21 18:05 ` Stefan Wahren
2021-03-30 6:07 Stephen Rothwell
2021-03-30 7:51 ` Linus Walleij
2020-04-17 2:27 Stephen Rothwell
2020-04-17 10:23 ` Linus Walleij
2018-10-11 3:17 Stephen Rothwell
2018-10-11 7:51 ` Linus Walleij
2017-06-30 4:56 Stephen Rothwell
2017-06-30 4:57 ` Stephen Rothwell
2017-06-30 6:59 ` Geert Uytterhoeven
2017-06-30 13:48 ` Linus Walleij
2017-01-03 4:37 Stephen Rothwell
2015-05-20 6:40 Stephen Rothwell
2015-05-20 7:14 ` Linus Walleij
2014-05-19 6:59 Stephen Rothwell
2014-05-19 9:03 ` Maxime Ripard
2013-12-13 4:06 Stephen Rothwell
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=20220120142539.6d1fac12@canb.auug.org.au \
--to=sfr@canb.auug.org.au \
--cc=corbet@lwn.net \
--cc=joey.gouly@arm.com \
--cc=linus.walleij@linaro.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-next@vger.kernel.org \
--cc=maz@kernel.org \
--cc=mchehab@kernel.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;
as well as URLs for NNTP newsgroup(s).