Re: [PATCH 5/5] thunderbolt: switch: Fix kernel-doc descriptions of non-static functions

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

 



On Thu, 28 Jan 2021, Mika Westerberg wrote:

> Fix kernel-doc descriptions of all non-static functions. This also gets
> rid of the warnings on W=1 build.
> 
> Reported-by: Lee Jones <lee.jones@xxxxxxxxxx>
> Signed-off-by: Mika Westerberg <mika.westerberg@xxxxxxxxxxxxxxx>
> ---
>  drivers/thunderbolt/switch.c | 7 +++++++
>  1 file changed, 7 insertions(+)
> 
> diff --git a/drivers/thunderbolt/switch.c b/drivers/thunderbolt/switch.c
> index 6ca3efba4520..6e2ca8f066f5 100644
> --- a/drivers/thunderbolt/switch.c
> +++ b/drivers/thunderbolt/switch.c
> @@ -525,6 +525,8 @@ int tb_port_state(struct tb_port *port)
>  
>  /**
>   * tb_wait_for_port() - wait for a port to become ready
> + * @port: Port to wait
> + * @wait_if_unplugged: Wait also when @port is unplugged

Nit: @port is usually used to specify the parameter directly.  In this
case I think you just want to say 'port', as you're referencing the
physical (or virtual) port, rather than this functions parameter.

Other than that, looks good:

Reviewed-by: Lee Jones <lee.jones@xxxxxxxxxx>

-- 
Lee Jones [李琼斯]
Senior Technical Lead - Developer Services
Linaro.org │ Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog



[Index of Archives]     [Linux Media]     [Linux Input]     [Linux Audio Users]     [Yosemite News]     [Linux Kernel]     [Linux SCSI]     [Old Linux USB Devel Archive]

  Powered by Linux