linux-kernel - Re: [PATCH -next] Input: Fix kernel-doc for xps2_of

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: <39b4b28b-8061-4af3-9129-d05a6f050719@amd.com>
Date: Fri, 1 Mar 2024 10:24:38 +0100
From: Michal Simek <michal.simek@....com>
To: Yang Li <yang.lee@...ux.alibaba.com>, dmitry.torokhov@...il.com
Cc: linux-input@...r.kernel.org, linux-arm-kernel@...ts.infradead.org,
 linux-kernel@...r.kernel.org
Subject: Re: [PATCH -next] Input: Fix kernel-doc for xps2_of_probe function



On 3/1/24 10:21, Yang Li wrote:
> The existing comment block above the xps2_of_probe function
> does not conform to the kernel-doc standard. This patch fixes the
> documentation to match the expected kernel-doc format, which includes
> a structured documentation header with param and return value.
> 
> Signed-off-by: Yang Li <yang.lee@...ux.alibaba.com>
> ---
>   drivers/input/serio/xilinx_ps2.c | 3 +--
>   1 file changed, 1 insertion(+), 2 deletions(-)
> 
> diff --git a/drivers/input/serio/xilinx_ps2.c b/drivers/input/serio/xilinx_ps2.c
> index d8f9faf2b529..bb758346a33d 100644
> --- a/drivers/input/serio/xilinx_ps2.c
> +++ b/drivers/input/serio/xilinx_ps2.c
> @@ -219,8 +219,7 @@ static void sxps2_close(struct serio *pserio)
>   
>   /**
>    * xps2_of_probe - probe method for the PS/2 device.
> - * @of_dev:	pointer to OF device structure
> - * @match:	pointer to the structure used for matching a device
> + * @ofdev:	pointer to OF device structure
>    *
>    * This function probes the PS/2 device in the device tree.
>    * It initializes the driver data structure and the hardware.

Reviewed-by: Michal Simek <michal.simek@....com>

Thanks,
Michal