linux-kernel - Re: [PATCH] gpio: Fix kernel-doc comments to nested union

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <84cdc48a-feb8-4aa5-7d96-a68f2c556e25@gmail.com>
Date:   Sun, 12 Jun 2022 09:02:33 +0900
From:   Akira Yokosawa <akiyks@...il.com>
To:     Linus Walleij <linus.walleij@...aro.org>,
        Bartosz Golaszewski <brgl@...ev.pl>, linux-gpio@...r.kernel.org
Cc:     Joey Gouly <joey.gouly@....com>, Marc Zyngier <maz@...nel.org>,
        Stephen Rothwell <sfr@...b.auug.org.au>,
        Mauro Carvalho Chehab <mchehab@...nel.org>,
        Jonathan Corbet <corbet@....net>, linux-kernel@...r.kernel.org,
        linux-next@...r.kernel.org
Subject: Re: [PATCH] gpio: Fix kernel-doc comments to nested union

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@...il.com>
> Reported-by: Stephen Rothwell <sfr@...b.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@...aro.org>
> Cc: Bartosz Golaszewski <brgl@...ev.pl>
> Cc: Joey Gouly <joey.gouly@....com>
> Cc: Marc Zyngier <maz@...nel.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