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

Message ID 20230927044128.4748-1-rdunlap@infradead.org
State New
Headers
Series [-next] serial: core: fix kernel-doc for uart_port_unlock_irqrestore() |

Commit Message

Randy Dunlap Sept. 27, 2023, 4:41 a.m. UTC
  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 <rdunlap@infradead.org>
Cc: Thomas Gleixner <tglx@linutronix.de>
Cc: John Ogness <john.ogness@linutronix.de>
Cc: linux-serial@vger.kernel.org
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Jiri Slaby <jirislaby@kernel.org>
---
 include/linux/serial_core.h |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
  

Comments

John Ogness Sept. 27, 2023, 7:39 a.m. UTC | #1
On 2023-09-26, Randy Dunlap <rdunlap@infradead.org> 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 <rdunlap@infradead.org>
> Cc: Thomas Gleixner <tglx@linutronix.de>
> Cc: John Ogness <john.ogness@linutronix.de>
> Cc: linux-serial@vger.kernel.org
> Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
> Cc: Jiri Slaby <jirislaby@kernel.org>

Thanks for catching and fixing this.

Reviewed-by: John Ogness <john.ogness@linutronix.de>
  

Patch

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
  */