Re: [PATCH] tty: correct kernel-doc inconsistency

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Tue, Jul 07, 2020 at 08:08:30AM +0200, Jiri Slaby wrote:
> On 07. 07. 20, 6:45, Colton Lewis wrote:
> > Silence documentation build warning by correcting argument names in
> > kernel-doc comment.
> > 
> > ./drivers/tty/serial/serial_core.c:3300: warning: Function parameter or member 'port' not described in 'uart_get_rs485_mode'
> > ./drivers/tty/serial/serial_core.c:3300: warning: Excess function parameter 'dev' description in 'uart_get_rs485_mode'
> > ./drivers/tty/serial/serial_core.c:3300: warning: Excess function parameter 'rs485conf' description in 'uart_get_rs485_mode'
> > 
> > Signed-off-by: Colton Lewis <colton.w.lewis@xxxxxxxxxxxxxx>
> 
> Fixes: c150c0f362c1 (serial: Allow uart_get_rs485_mode() to return errno)
> Acked-by: Jiri Slaby <jirislaby@xxxxxxxxxx>

Already fixed by a71725619ff6 ("tty/serial: fix serial_core.c kernel-doc
warnings"), which is queued on Greg's tty-linus branch:

https://git.kernel.org/pub/scm/linux/kernel/git/gregkh/tty.git/commit/?h=tty-linus&id=a71725619ff6

Thanks (and sorry for the warnings),

Lukas

> 
> > --- a/drivers/tty/serial/serial_core.c
> > +++ b/drivers/tty/serial/serial_core.c
> > @@ -3289,8 +3289,7 @@ EXPORT_SYMBOL(uart_remove_one_port);
> >  
> >  /**
> >   * uart_get_rs485_mode() - retrieve rs485 properties for given uart
> > - * @dev: uart device
> > - * @rs485conf: output parameter
> > + * @port: uart device
> >   *
> >   * This function implements the device tree binding described in
> >   * Documentation/devicetree/bindings/serial/rs485.txt.



[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux PPP]     [Linux FS]     [Yosemite News]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Linmodem]     [Device Mapper]     [Linux Kernel for ARM]

  Powered by Linux