Fix documentation build warnings against 6.0-rc1

[PATCH 12/13] serial: document start_rx member at struct uart_ops

Posted by Mauro Carvalho Chehab 3 years, 3 months ago

Fix this doc build warning:
	./include/linux/serial_core.h:397: warning: Function parameter or member 'start_rx' not described in 'uart_ops'

Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
---

See [PATCH 00/13] at: https://lore.kernel.org/all/cover.1660829433.git.mchehab@kernel.org/

 include/linux/serial_core.h | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/include/linux/serial_core.h b/include/linux/serial_core.h
index aef3145f2032..6e4f4765d209 100644
--- a/include/linux/serial_core.h
+++ b/include/linux/serial_core.h
@@ -141,6 +141,14 @@ struct gpio_desc;
  *	Locking: none.
  *	Interrupts: caller dependent.
  *
+ * @start_rx: ``void ()(struct uart_port *port)``
+ *
+ *	Start receiving characters.
+ *
+ *	Locking: @port->lock taken.
+ *	Interrupts: locally disabled.
+ *	This call must not sleep
+ *
  * @stop_rx: ``void ()(struct uart_port *port)``
  *
  *	Stop receiving characters; the @port is in the process of being closed.
-- 
2.37.1

Re: [PATCH 12/13] serial: document start_rx member at struct uart_ops

Posted by Jiri Slaby 3 years, 3 months ago

On 18. 08. 22, 15:38, Mauro Carvalho Chehab wrote:
> Fix this doc build warning:
> 	./include/linux/serial_core.h:397: warning: Function parameter or member 'start_rx' not described in 'uart_ops'

Reviewed-by: Jiri Slaby <jirislaby@kernel.org>


> Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
> ---
> 
> See [PATCH 00/13] at: https://lore.kernel.org/all/cover.1660829433.git.mchehab@kernel.org/
> 
>   include/linux/serial_core.h | 8 ++++++++
>   1 file changed, 8 insertions(+)
> 
> diff --git a/include/linux/serial_core.h b/include/linux/serial_core.h
> index aef3145f2032..6e4f4765d209 100644
> --- a/include/linux/serial_core.h
> +++ b/include/linux/serial_core.h
> @@ -141,6 +141,14 @@ struct gpio_desc;
>    *	Locking: none.
>    *	Interrupts: caller dependent.
>    *
> + * @start_rx: ``void ()(struct uart_port *port)``
> + *
> + *	Start receiving characters.
> + *
> + *	Locking: @port->lock taken.
> + *	Interrupts: locally disabled.
> + *	This call must not sleep
> + *
>    * @stop_rx: ``void ()(struct uart_port *port)``
>    *
>    *	Stop receiving characters; the @port is in the process of being closed.

thanks,
-- 
js
suse labs