2023-04-21 10:02:57

by Geert Uytterhoeven

Subject: [PATCH] serial: 8250: Document termios parameter of serial8250_em485_config()

With W=1:

drivers/tty/serial/8250/8250_port.c:679: warning: Function parameter or member 'termios' not described in 'serial8250_em485_config'

Fix this by documenting the parameter.

Fixes: ae50bb2752836277 ("serial: take termios_rwsem for ->rs485_config() & pass termios as param")
Signed-off-by: Geert Uytterhoeven <[email protected]>
---
drivers/tty/serial/8250/8250_port.c | 1 +
1 file changed, 1 insertion(+)

diff --git a/drivers/tty/serial/8250/8250_port.c b/drivers/tty/serial/8250/8250_port.c
index dfbc501cf9d1561e..a0fd5ecc07ac66f3 100644
--- a/drivers/tty/serial/8250/8250_port.c
+++ b/drivers/tty/serial/8250/8250_port.c
@@ -668,6 +668,7 @@ EXPORT_SYMBOL_GPL(serial8250_em485_supported);
/**
* serial8250_em485_config() - generic ->rs485_config() callback
* @port: uart port
+ * @termios: termios structure
* @rs485: rs485 settings
*
* Generic callback usable by 8250 uart drivers to activate rs485 settings
--
2.34.1

2023-04-24 09:25:23

by Jiri Slaby

Subject: Re: [PATCH] serial: 8250: Document termios parameter of serial8250_em485_config()

On 21. 04. 23, 11:58, Geert Uytterhoeven wrote:
> With W=1:
>
> drivers/tty/serial/8250/8250_port.c:679: warning: Function parameter or member 'termios' not described in 'serial8250_em485_config'
>
> Fix this by documenting the parameter.
>
> Fixes: ae50bb2752836277 ("serial: take termios_rwsem for ->rs485_config() & pass termios as param")
> Signed-off-by: Geert Uytterhoeven <[email protected]>

Reviewed-by: Jiri Slaby <[email protected]>

thanks,
--
js
suse labs