diff mbox series

serial: xilinx_uartps: Fix kernel doc about .remove()'s return code

Message ID 20231117101236.878008-1-u.kleine-koenig@pengutronix.de
State New
Headers show
Series serial: xilinx_uartps: Fix kernel doc about .remove()'s return code | expand

Commit Message

Uwe Kleine-König Nov. 17, 2023, 10:12 a.m. UTC
Since the driver was converted to use .remove_new() the return function
doesn't return a value any more. So remove the obsolete documentation
about the return value.

Reported-by: Michal Simek <michal.simek@amd.com>
Signed-off-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
---
Hello,

the patch converting to .remove_new is not yet applied, so I didn't
reference its commit id. It's available at

	https://lore.kernel.org/linux-serial/20231110152927.70601-53-u.kleine-koenig@pengutronix.de

and obviously this patch dropping the comment should get applied after
the conversion to void.

Best regards
Uwe

 drivers/tty/serial/xilinx_uartps.c | 2 --
 1 file changed, 2 deletions(-)


base-commit: eff99d8edbed7918317331ebd1e365d8e955d65e
prerequisite-patch-id: 78ddb8b8246b06d5805c7dc8ad6481c7e4bc22c8

Comments

Jiri Slaby Nov. 20, 2023, 7:27 a.m. UTC | #1
On 17. 11. 23, 11:12, Uwe Kleine-König wrote:
> Since the driver was converted to use .remove_new() the return function
> doesn't return a value any more. So remove the obsolete documentation
> about the return value.
> 
> Reported-by: Michal Simek <michal.simek@amd.com>
> Signed-off-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
> ---
> Hello,
> 
> the patch converting to .remove_new is not yet applied, so I didn't
> reference its commit id. It's available at
> 
> 	https://lore.kernel.org/linux-serial/20231110152927.70601-53-u.kleine-koenig@pengutronix.de
> 
> and obviously this patch dropping the comment should get applied after
> the conversion to void.

So perhaps you squash and resend :)?

thanks,
diff mbox series

Patch

diff --git a/drivers/tty/serial/xilinx_uartps.c b/drivers/tty/serial/xilinx_uartps.c
index 6decf2b13340..920762d7b4a4 100644
--- a/drivers/tty/serial/xilinx_uartps.c
+++ b/drivers/tty/serial/xilinx_uartps.c
@@ -1663,8 +1663,6 @@  static int cdns_uart_probe(struct platform_device *pdev)
 /**
  * cdns_uart_remove - called when the platform driver is unregistered
  * @pdev: Pointer to the platform device structure
- *
- * Return: 0 on success, negative errno otherwise
  */
 static void cdns_uart_remove(struct platform_device *pdev)
 {