2023-09-27 06:50:25

by Randy Dunlap

Subject: [PATCH -next] serial: core: fix kernel-doc for uart_port_unlock_irqrestore()

Fix the function name to avoid a kernel-doc warning:

include/linux/serial_core.h:666: warning: expecting prototype for uart_port_lock_irqrestore(). Prototype was for uart_port_unlock_irqrestore() instead

Fixes: b0af4bcb4946 ("serial: core: Provide port lock wrappers")
Signed-off-by: Randy Dunlap <[email protected]>
Cc: Thomas Gleixner <[email protected]>
Cc: John Ogness <[email protected]>
Cc: [email protected]
Cc: Greg Kroah-Hartman <[email protected]>
Cc: Jiri Slaby <[email protected]>
---
include/linux/serial_core.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff -- a/include/linux/serial_core.h b/include/linux/serial_core.h
--- a/include/linux/serial_core.h
+++ b/include/linux/serial_core.h
@@ -658,7 +658,7 @@ static inline void uart_port_unlock_irq(
}

/**
- * uart_port_lock_irqrestore - Unlock the UART port, restore interrupts
+ * uart_port_unlock_irqrestore - Unlock the UART port, restore interrupts
* @up: Pointer to UART port structure
* @flags: The saved interrupt flags for restore
*/

2023-09-27 12:17:08

by John Ogness

Subject: Re: [PATCH -next] serial: core: fix kernel-doc for uart_port_unlock_irqrestore()

On 2023-09-26, Randy Dunlap <[email protected]> wrote:
> Fix the function name to avoid a kernel-doc warning:
>
> include/linux/serial_core.h:666: warning: expecting prototype for uart_port_lock_irqrestore(). Prototype was for uart_port_unlock_irqrestore() instead
>
> Fixes: b0af4bcb4946 ("serial: core: Provide port lock wrappers")
> Signed-off-by: Randy Dunlap <[email protected]>
> Cc: Thomas Gleixner <[email protected]>
> Cc: John Ogness <[email protected]>
> Cc: [email protected]
> Cc: Greg Kroah-Hartman <[email protected]>
> Cc: Jiri Slaby <[email protected]>

Thanks for catching and fixing this.

Reviewed-by: John Ogness <[email protected]>