Re: [PATCH] tty: serial: uartlite: Document uartlite_data in kernel-doc style

[Randy Dunlap]

On 11/6/23 07:24, Sean Anderson wrote:
> Use @ and - to conform with kernel-doc style.
> 
> Reported-by: kernel test robot <yujie.liu@xxxxxxxxx>
> Signed-off-by: Sean Anderson <sean.anderson@xxxxxxxx>

Reviewed-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>

Thanks.

Greg will probably just wait to apply it sometime after the current
merge window closes. At least that's been my experience.

> ---
> I have no idea what phase of release the kernel is in. If it is too
> late/early in the cycle, please just review this at the appropriate
> time. This patch is unlikely to need rebasing, and I am unlikely to
> remember to send it later.
> 
>  drivers/tty/serial/uartlite.c | 10 +++++-----
>  1 file changed, 5 insertions(+), 5 deletions(-)
> 
> diff --git a/drivers/tty/serial/uartlite.c b/drivers/tty/serial/uartlite.c
> index 404c14acafa5..e586d7aeac98 100644
> --- a/drivers/tty/serial/uartlite.c
> +++ b/drivers/tty/serial/uartlite.c
> @@ -62,11 +62,11 @@ static struct uart_port *console_port;
>  #endif
>  
>  /**
> - * struct uartlite_data: Driver private data
> - * reg_ops: Functions to read/write registers
> - * clk: Our parent clock, if present
> - * baud: The baud rate configured when this device was synthesized
> - * cflags: The cflags for parity and data bits
> + * struct uartlite_data - Driver private data
> + * @reg_ops: Functions to read/write registers
> + * @clk: Our parent clock, if present
> + * @baud: The baud rate configured when this device was synthesized
> + * @cflags: The cflags for parity and data bits
>   */
>  struct uartlite_data {
>  	const struct uartlite_reg_ops *reg_ops;

-- 
~Randy