* [PATCH] gpio: Fix kernel-doc comments to nested union
@ 2022-06-06 4:44 Akira Yokosawa
2022-06-06 5:48 ` Stephen Rothwell
` (2 more replies)
0 siblings, 3 replies; 5+ messages in thread
From: Akira Yokosawa @ 2022-06-06 4:44 UTC (permalink / raw)
To: Linus Walleij, Bartosz Golaszewski, linux-gpio
Cc: Joey Gouly, Marc Zyngier, Stephen Rothwell,
Mauro Carvalho Chehab, Jonathan Corbet, linux-kernel, linux-next,
Akira Yokosawa
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>
---
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
--
2.25.1
^ permalink raw reply related [flat|nested] 5+ messages in thread
* Re: [PATCH] gpio: Fix kernel-doc comments to nested union
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
2 siblings, 0 replies; 5+ messages in thread
From: Stephen Rothwell @ 2022-06-06 5:48 UTC (permalink / raw)
To: Akira Yokosawa
Cc: Linus Walleij, Bartosz Golaszewski, linux-gpio, Joey Gouly,
Marc Zyngier, Mauro Carvalho Chehab, Jonathan Corbet,
linux-kernel, linux-next
[-- Attachment #1: Type: text/plain, Size: 1122 bytes --]
Hi Akira,
On Mon, 6 Jun 2022 13:44:24 +0900 Akira Yokosawa <akiyks@gmail.com> 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>
> ---
> include/linux/gpio/driver.h | 29 ++++++++++++++++-------------
> 1 file changed, 16 insertions(+), 13 deletions(-)
Looks good, thanks.
Tested-by: Stephen Rothwell <sfr@canb.auug.org.au>
--
Cheers,
Stephen Rothwell
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] gpio: Fix kernel-doc comments to nested union
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
2 siblings, 0 replies; 5+ messages in thread
From: Mauro Carvalho Chehab @ 2022-06-06 7:50 UTC (permalink / raw)
To: Akira Yokosawa
Cc: Linus Walleij, Bartosz Golaszewski, linux-gpio, Joey Gouly,
Marc Zyngier, Stephen Rothwell, Jonathan Corbet, linux-kernel,
linux-next
Em Mon, 6 Jun 2022 13:44:24 +0900
Akira Yokosawa <akiyks@gmail.com> escreveu:
> 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>
> ---
> 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;
> };
Yeah, kernel-doc expects inlined comments to be just before each
declaration like the above.
Reviewed-by: Mauro Carvalho Chehab <mchehab@kernel.org>
Regards,
Mauro
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] gpio: Fix kernel-doc comments to nested union
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
2022-06-23 20:20 ` Bartosz Golaszewski
2 siblings, 1 reply; 5+ messages in thread
From: Akira Yokosawa @ 2022-06-12 0:02 UTC (permalink / raw)
To: Linus Walleij, Bartosz Golaszewski, linux-gpio
Cc: Joey Gouly, Marc Zyngier, Stephen Rothwell,
Mauro Carvalho Chehab, Jonathan Corbet, linux-kernel, linux-next
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
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] gpio: Fix kernel-doc comments to nested union
2022-06-12 0:02 ` Akira Yokosawa
@ 2022-06-23 20:20 ` Bartosz Golaszewski
0 siblings, 0 replies; 5+ messages in thread
From: Bartosz Golaszewski @ 2022-06-23 20:20 UTC (permalink / raw)
To: Akira Yokosawa
Cc: Linus Walleij, open list:GPIO SUBSYSTEM, Joey Gouly,
Marc Zyngier, Stephen Rothwell, Mauro Carvalho Chehab,
Jonathan Corbet, Linux Kernel Mailing List,
Linux Next Mailing List
On Sun, Jun 12, 2022 at 2:02 AM Akira Yokosawa <akiyks@gmail.com> wrote:
>
> 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
>
Now applied, thanks! Sorry for the delay.
Bart
^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2022-06-23 20:20 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
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
2022-06-23 20:20 ` Bartosz Golaszewski
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).