linux-kernel - Re: [PATCH 12/13] serial: document start_rx member at struct uart

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <362b55e8-6f98-6723-6751-92dbe16ea924@kernel.org>
Date:   Fri, 19 Aug 2022 07:20:39 +0200
From:   Jiri Slaby <jirislaby@...nel.org>
To:     Mauro Carvalho Chehab <mchehab@...nel.org>,
        Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        corbet@....net
Cc:     Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH 12/13] serial: document start_rx member at struct uart_ops

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@...nel.org>


> Signed-off-by: Mauro Carvalho Chehab <mchehab@...nel.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