From: Akira Yokosawa <akiyks@gmail.com>
To: Linus Walleij <linus.walleij@linaro.org>,
Bartosz Golaszewski <brgl@bgdev.pl>,
linux-gpio@vger.kernel.org
Cc: Joey Gouly <joey.gouly@arm.com>, Marc Zyngier <maz@kernel.org>,
Stephen Rothwell <sfr@canb.auug.org.au>,
Mauro Carvalho Chehab <mchehab@kernel.org>,
Jonathan Corbet <corbet@lwn.net>,
linux-kernel@vger.kernel.org, linux-next@vger.kernel.org
Subject: Re: [PATCH] gpio: Fix kernel-doc comments to nested union
Date: Sun, 12 Jun 2022 09:02:33 +0900 [thread overview]
Message-ID: <84cdc48a-feb8-4aa5-7d96-a68f2c556e25@gmail.com> (raw)
In-Reply-To: <27612e81-d843-d161-ecd2-c653c7d5bae9@gmail.com>
On Mon, 6 Jun 2022 13:44:24 +0900, Akira Yokosawa wrote:
> Commit 48ec13d36d3f ("gpio: Properly document parent data union")
> is supposed to have fixed a warning from "make htmldocs" regarding
> kernel-doc comments to union members. However, the same warning
> still remains [1].
>
> Fix the issue by following the example found in section "Nested
> structs/unions" of Documentation/doc-guide/kernel-doc.rst.
>
> Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Fixes: 48ec13d36d3f ("gpio: Properly document parent data union")
> Link: https://lore.kernel.org/r/20220606093302.21febee3@canb.auug.org.au/ [1]
> Cc: Linus Walleij <linus.walleij@linaro.org>
> Cc: Bartosz Golaszewski <brgl@bgdev.pl>
> Cc: Joey Gouly <joey.gouly@arm.com>
> Cc: Marc Zyngier <maz@kernel.org>
Gentle ping to gpio maintainers.
I thought this fix would go through brgl's tree.
Thanks, Akira
> ---
> include/linux/gpio/driver.h | 29 ++++++++++++++++-------------
> 1 file changed, 16 insertions(+), 13 deletions(-)
>
> diff --git a/include/linux/gpio/driver.h b/include/linux/gpio/driver.h
> index b1e0f1f8ee2e..54c3c6506503 100644
> --- a/include/linux/gpio/driver.h
> +++ b/include/linux/gpio/driver.h
> @@ -167,21 +167,24 @@ struct gpio_irq_chip {
> */
> irq_flow_handler_t parent_handler;
>
> - /**
> - * @parent_handler_data:
> - *
> - * If @per_parent_data is false, @parent_handler_data is a single
> - * pointer used as the data associated with every parent interrupt.
> - *
> - * @parent_handler_data_array:
> - *
> - * If @per_parent_data is true, @parent_handler_data_array is
> - * an array of @num_parents pointers, and is used to associate
> - * different data for each parent. This cannot be NULL if
> - * @per_parent_data is true.
> - */
> union {
> + /**
> + * @parent_handler_data:
> + *
> + * If @per_parent_data is false, @parent_handler_data is a
> + * single pointer used as the data associated with every
> + * parent interrupt.
> + */
> void *parent_handler_data;
> +
> + /**
> + * @parent_handler_data_array:
> + *
> + * If @per_parent_data is true, @parent_handler_data_array is
> + * an array of @num_parents pointers, and is used to associate
> + * different data for each parent. This cannot be NULL if
> + * @per_parent_data is true.
> + */
> void **parent_handler_data_array;
> };
>
>
> base-commit: f2906aa863381afb0015a9eb7fefad885d4e5a56
next prev parent reply other threads:[~2022-06-12 0:02 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-06-06 4:44 [PATCH] gpio: Fix kernel-doc comments to nested union Akira Yokosawa
2022-06-06 5:48 ` Stephen Rothwell
2022-06-06 7:50 ` Mauro Carvalho Chehab
2022-06-12 0:02 ` Akira Yokosawa [this message]
2022-06-23 20:20 ` Bartosz Golaszewski
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=84cdc48a-feb8-4aa5-7d96-a68f2c556e25@gmail.com \
--to=akiyks@gmail.com \
--cc=brgl@bgdev.pl \
--cc=corbet@lwn.net \
--cc=joey.gouly@arm.com \
--cc=linus.walleij@linaro.org \
--cc=linux-gpio@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-next@vger.kernel.org \
--cc=maz@kernel.org \
--cc=mchehab@kernel.org \
--cc=sfr@canb.auug.org.au \
/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).