Received-SPF: pass (google.com: domain of linux-kernel+bounces-88173-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:45d1:ec00::1 as permitted sender) client-ip=2604:1380:45d1:ec00::1;
Message-ID: <39b4b28b-8061-4af3-9129-d05a6f050719@amd.com>
Date: Fri, 1 Mar 2024 10:24:38 +0100
User-Agent: Mozilla Thunderbird
Subject: Re: [PATCH -next] Input: Fix kernel-doc for xps2_of_probe function
Content-Language: en-US
To: Yang Li <yang.lee@linux.alibaba.com>, dmitry.torokhov@gmail.com
Cc: linux-input@vger.kernel.org, linux-arm-kernel@lists.infradead.org,
 linux-kernel@vger.kernel.org
References: <20240301092115.123092-1-yang.lee@linux.alibaba.com>
From: Michal Simek <michal.simek@amd.com>
Autocrypt: addr=michal.simek@amd.com; keydata=
 xsFNBFFuvDEBEAC9Amu3nk79+J+4xBOuM5XmDmljuukOc6mKB5bBYOa4SrWJZTjeGRf52VMc
 howHe8Y9nSbG92obZMqsdt+d/hmRu3fgwRYiiU97YJjUkCN5paHXyBb+3IdrLNGt8I7C9RMy
 svSoH4WcApYNqvB3rcMtJIna+HUhx8xOk+XCfyKJDnrSuKgx0Svj446qgM5fe7RyFOlGX/wF
 Ae63Hs0RkFo3I/+hLLJP6kwPnOEo3lkvzm3FMMy0D9VxT9e6Y3afe1UTQuhkg8PbABxhowzj
 SEnl0ICoqpBqqROV/w1fOlPrm4WSNlZJunYV4gTEustZf8j9FWncn3QzRhnQOSuzTPFbsbH5
 WVxwDvgHLRTmBuMw1sqvCc7CofjsD1XM9bP3HOBwCxKaTyOxbPJh3D4AdD1u+cF/lj9Fj255
 Es9aATHPvoDQmOzyyRNTQzupN8UtZ+/tB4mhgxWzorpbdItaSXWgdDPDtssJIC+d5+hskys8
 B3jbv86lyM+4jh2URpnL1gqOPwnaf1zm/7sqoN3r64cml94q68jfY4lNTwjA/SnaS1DE9XXa
 XQlkhHgjSLyRjjsMsz+2A4otRLrBbumEUtSMlPfhTi8xUsj9ZfPIUz3fji8vmxZG/Da6jx/c
 a0UQdFFCL4Ay/EMSoGbQouzhC69OQLWNH3rMQbBvrRbiMJbEZwARAQABzSlNaWNoYWwgU2lt
 ZWsgKEFNRCkgPG1pY2hhbC5zaW1la0BhbWQuY29tPsLBlAQTAQgAPgIbAwULCQgHAgYVCgkI
 CwIEFgIDAQIeAQIXgBYhBGc1DJv1zO6bU2Q1ajd8fyH+PR+RBQJkK9VOBQkWf4AXAAoJEDd8
 fyH+PR+ROzEP/1IFM7J4Y58SKuvdWDddIvc7JXcal5DpUtMdpuV+ZiHSOgBQRqvwH4CVBK7p
 ktDCWQAoWCg0KhdGyBjfyVVpm+Gw4DkZovcvMGUlvY5p5w8XxTE5Xx+cj/iDnj83+gy+0Oyz
 VFU9pew9rnT5YjSRFNOmL2dsorxoT1DWuasDUyitGy9iBegj7vtyAsvEObbGiFcKYSjvurkm
 MaJ/AwuJehZouKVfWPY/i4UNsDVbQP6iwO8jgPy3pwjt4ztZrl3qs1gV1F4Zrak1k6qoDP5h
 19Q5XBVtq4VSS4uLKjofVxrw0J+sHHeTNa3Qgk9nXJEvH2s2JpX82an7U6ccJSdNLYbogQAS
 BW60bxq6hWEY/afbT+tepEsXepa0y04NjFccFsbECQ4DA3cdA34sFGupUy5h5la/eEf3/8Kd
 BYcDd+aoxWliMVmL3DudM0Fuj9Hqt7JJAaA0Kt3pwJYwzecl/noK7kFhWiKcJULXEbi3Yf/Y
 pwCf691kBfrbbP9uDmgm4ZbWIT5WUptt3ziYOWx9SSvaZP5MExlXF4z+/KfZAeJBpZ95Gwm+
 FD8WKYjJChMtTfd1VjC4oyFLDUMTvYq77ABkPeKB/WmiAoqMbGx+xQWxW113wZikDy+6WoCS
 MPXfgMPWpkIUnvTIpF+m1Nyerqf71fiA1W8l0oFmtCF5oTMkzsFNBFFuvDEBEACXqiX5h4IA
 03fJOwh+82aQWeHVAEDpjDzK5hSSJZDE55KP8br1FZrgrjvQ9Ma7thSu1mbr+ydeIqoO1/iM
 fZA+DDPpvo6kscjep11bNhVa0JpHhwnMfHNTSHDMq9OXL9ZZpku/+OXtapISzIH336p4ZUUB
 5asad8Ux70g4gmI92eLWBzFFdlyR4g1Vis511Nn481lsDO9LZhKyWelbif7FKKv4p3FRPSbB
 vEgh71V3NDCPlJJoiHiYaS8IN3uasV/S1+cxVbwz2WcUEZCpeHcY2qsQAEqp4GM7PF2G6gtz
 IOBUMk7fjku1mzlx4zP7uj87LGJTOAxQUJ1HHlx3Li+xu2oF9Vv101/fsCmptAAUMo7KiJgP
 Lu8TsP1migoOoSbGUMR0jQpUcKF2L2jaNVS6updvNjbRmFojK2y6A/Bc6WAKhtdv8/e0/Zby
 iVA7/EN5phZ1GugMJxOLHJ1eqw7DQ5CHcSQ5bOx0Yjmhg4PT6pbW3mB1w+ClAnxhAbyMsfBn
 XxvvcjWIPnBVlB2Z0YH/gizMDdM0Sa/HIz+q7JR7XkGL4MYeAM15m6O7hkCJcoFV7LMzkNKk
 OiCZ3E0JYDsMXvmh3S4EVWAG+buA+9beElCmXDcXPI4PinMPqpwmLNcEhPVMQfvAYRqQp2fg
 1vTEyK58Ms+0a9L1k5MvvbFg9QARAQABwsF8BBgBCAAmAhsMFiEEZzUMm/XM7ptTZDVqN3x/
 If49H5EFAmQr1YsFCRZ/gFoACgkQN3x/If49H5H6BQ//TqDpfCh7Fa5v227mDISwU1VgOPFK
 eo/+4fF/KNtAtU/VYmBrwT/N6clBxjJYY1i60ekFfAEsCb+vAr1W9geYYpuA+lgR3/BOkHlJ
 eHf4Ez3D71GnqROIXsObFSFfZWGEgBtHBZ694hKwFmIVCg+lqeMV9nPQKlvfx2n+/lDkspGi
 epDwFUdfJLHOYxFZMQsFtKJX4fBiY85/U4X2xSp02DxQZj/N2lc9OFrKmFJHXJi9vQCkJdIj
 S6nuJlvWj/MZKud5QhlfZQsixT9wCeOa6Vgcd4vCzZuptx8gY9FDgb27RQxh/b1ZHalO1h3z
 kXyouA6Kf54Tv6ab7M/fhNqznnmSvWvQ4EWeh8gddpzHKk8ixw9INBWkGXzqSPOztlJbFiQ3
 YPi6o9Pw/IxdQJ9UZ8eCjvIMpXb4q9cZpRLT/BkD4ttpNxma1CUVljkF4DuGydxbQNvJFBK8
 ywyA0qgv+Mu+4r/Z2iQzoOgE1SymrNSDyC7u0RzmSnyqaQnZ3uj7OzRkq0fMmMbbrIvQYDS/
 y7RkYPOpmElF2pwWI/SXKOgMUgigedGCl1QRUio7iifBmXHkRrTgNT0PWQmeGsWTmfRit2+i
 l2dpB2lxha72cQ6MTEmL65HaoeANhtfO1se2R9dej57g+urO9V2v/UglZG1wsyaP/vOrgs+3
 3i3l5DA=
In-Reply-To: <20240301092115.123092-1-yang.lee@linux.alibaba.com>
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 7bit
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0:
	=?utf-8?B?UmE2S21xN1FRbTFKSS9wSFhZb3BMbVpTcVJTRG1tVFl2bXllSUExaVgrNGxN?=
 =?utf-8?B?SFJMVjdPMWxNZmpvUG5zbXYwWTVFRnJueVVycUpnNkZDWUhvNEFoSXdJT3k0?=
 =?utf-8?B?UVdFYmlrMTJFcWxzUE5kNVNwdWpSbEVob1VYNGVHRENORjlaZ2NxNzdXdzNK?=
 =?utf-8?B?QUdKQTYvbmdVNyt6NVdLeTRac3Z3QkNpSjJJTG5RQ2ZhVitwMXVyb2swSmpr?=
 =?utf-8?B?anhWL0dncU5FUlQwOHZ5dC9hYUw2N0YyMzh4L25JL0JQbGZRLzNSQU9NVDZO?=
 =?utf-8?B?c3RxNWQrajJrMnFHQ25EdGtLODdhMnJ0OHlXeUh5UGtQbFkwSnJzclU3Z3hY?=
 =?utf-8?B?cnFFZ3dCMVkyS05sZzE5ZVV4SDZlMlVTbFBhdTlRSFFHd2ZsTkVkUGJGQ2dO?=
 =?utf-8?B?OXpBc01ZUjBkUDRZM05UR1RXa2N2YmRNVFpuQzE2UUVIWlNrTTVtMVdVYjdh?=
 =?utf-8?B?bzRvQlVMSVI4d3RqMEZlSndwbkk1UkcycU5lL1VPUnp1V1lkT0pRVGcwTkFi?=
 =?utf-8?B?cnFWN0pEK0hYTTZjOVg4UlgveURwNk5OK1NvV09GNXd0MlcrdmpDMnZ5M3hk?=
 =?utf-8?B?RlRaM3BwSFVoeHZaTTJrRXljRDJpZ2FyeVJJU1l2MTM0UXRUd0N0SytpRnN2?=
 =?utf-8?B?QnJOS1VDcnRsdkdPRDhrL2xVRnpkSjdIYVlmaXJITW5tRXFUbmlkOGc1bmVm?=
 =?utf-8?B?Z3FGY0tkd1FsK2VKWTN2YnoyS0ZMRXRGMjBWTHZjclIxL24reHNERE1kdk5R?=
 =?utf-8?B?K1g1TXNVZU1UN2Ntdkd6WWpydVJobW5FY001ZDJPRHNWdno1R2Z0SHB4YUd2?=
 =?utf-8?B?d05DRVEyYVUyL3hiWVhrM0VmeXpZMXJhcjF6RTAxSVNidmcvOVk5NStvSVhq?=
 =?utf-8?B?Sk1QdkxKNjVvUmRORGdvc1RWTTNNS0xVUDJiT0ZIaEEzdVBlV1RSMGZHdjc2?=
 =?utf-8?B?TkxaUXZ3Wi9hdjhMS2cyQTZaQjVDb0ZWcnpTOUhmZGo4eGlpQzF0RXg4LzJP?=
 =?utf-8?B?d2ZlSDJTTUdrYVZyRktaKzczUXZ2dGR5OHB2VFdkWlZtaWxZaWRCZlRuMVNu?=
 =?utf-8?B?UmRlYVZORWdYeFdmYzVYTXVWcXg0MEgvampHazVTNzlSRWlHbHdzRnM3ZW1F?=
 =?utf-8?B?ZDlJZWJ4T3NtL0VSeUxUejRYWFh1ZlBmS0Zld3dUVEdraVpiRFdyTFAzNkVZ?=
 =?utf-8?B?azV2RDZ4Z3NObTZQeHRNamd0akthMG4rMXpZbUNnRUN4cTlFdzk2d2sxeDVi?=
 =?utf-8?B?UDVlTnN3ZlFSSVUxQ3VhdFZ0a3FDaXJoRjUrSTNBMks4U0xsTks0dHBlb0ZW?=
 =?utf-8?B?emFPSWEzMEF2WUNPTjFVWG55QkNNQ1Frc01SV1QwQXhVUnR1Wk0ySHluWndi?=
 =?utf-8?B?dWdMQm0xdzNRVDJTK3hnanlIYWpSWjdZKzBheEVDVW1mT1d0aWVYTnYyQUoy?=
 =?utf-8?B?K3JpcnV2OWhJUnlyZWE3L3UxTFNLQk40OFlTdzNpNjJ1QmdwMVdmVWNncEsw?=
 =?utf-8?B?dHZjYUdleGxmWFF3V24zb09SLzVuQUJWSFEvaFJiSTJUOTNhcnZBUEVadHVu?=
 =?utf-8?B?elgwaFdHczIzZ2lpSlNXUDhZdDdYNE8vb2JKWnhaZVN4US8wSi9uYmZpb0tj?=
 =?utf-8?B?eElrTlg4ZFJKRkV1aE11eTNPZ1FjUEJpVUYzLzhXSjRNSXhsUDlkWHpmUGRZ?=
 =?utf-8?B?UmlzM2tWZ2FETklEZWpOcUY5VkQ3SWpodDhQTHNwSnppMm5yMmNBMHdoeE1L?=
 =?utf-8?B?c3MrN0VHZHVLLzZ1YXNLMW9EeVpQdGYyL2FlTGlZeWlsejcwMWxUSFFJUVZK?=
 =?utf-8?B?bkhZa2d4aXpVWFJQM1djakRjTjRhVi8rYnBmTWZSRWVYTERRNkExK2hvN3Fa?=
 =?utf-8?B?RWRqUXBvajNzc3F5K2lrbGRQYjRNSjZPdFJKbS81SkZ1bExDNThjQVpJZS81?=
 =?utf-8?B?RGVRWDdodExRa2p3ZmNKSGpXclplMkVHYWQzTlJiZ1VGOWloNEN3dE9aMWxR?=
 =?utf-8?B?Z1Faa1dMazRiWW14RFBRUUNUOFFHVXpoYUhVWDJkV1ZRMTFzVjMvQVBEMzc3?=
 =?utf-8?B?OVoxU0hBZkozTWZKRjViM2w5cTh0dXUvS0dvVExiYmRiZjBSbGMvZCtQTEtW?=
 =?utf-8?Q?j2QiCvRNqtiwp+cJlL19LeqqN?=
X-OriginatorOrg: amd.com
X-MS-Exchange-CrossTenant-Network-Message-Id: d0546979-ac30-4462-5762-08dc39d16d88
X-MS-Exchange-CrossTenant-AuthSource: SJ2PR12MB8109.namprd12.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 01 Mar 2024 09:24:43.0716
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 3dd8961f-e488-4e60-8e11-a82d994e183d
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: NcEivyznKRrS/hckoy8QI1UNV+HPp5dPiDcfkw0tCpSyvI7Qr6tu8xDhWdxSvsbD
X-MS-Exchange-Transport-CrossTenantHeadersStamped: IA1PR12MB8407


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@linux.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@amd.com>

Thanks,
Michal