Re: [PATCH v2 06/29] scsi: fcoe: fcoe_transport: Correct some kernel-doc issues

[Hannes Reinecke]

On 7/13/20 9:46 AM, Lee Jones wrote:
> Mainly due to misdocumentation or bitrotted descriptions.
>
> Fixes the following W=1 kernel build warning(s):
>
>   drivers/scsi/fcoe/fcoe_transport.c:396: warning: Function parameter or member 'skb' not described in 'fcoe_check_wait_queue'
>   drivers/scsi/fcoe/fcoe_transport.c:447: warning: Function parameter or member 't' not described in 'fcoe_queue_timer'
>   drivers/scsi/fcoe/fcoe_transport.c:447: warning: Excess function parameter 'lport' description in 'fcoe_queue_timer'
>   drivers/scsi/fcoe/fcoe_transport.c:682: warning: Function parameter or member 'netdev' not described in 'fcoe_netdev_map_lookup'
>
> Cc: Hannes Reinecke <hare@xxxxxxx>
> Signed-off-by: Lee Jones <lee.jones@xxxxxxxxxx>
> ---
>   drivers/scsi/fcoe/fcoe_transport.c | 4 +++-
>   1 file changed, 3 insertions(+), 1 deletion(-)
>
> diff --git a/drivers/scsi/fcoe/fcoe_transport.c b/drivers/scsi/fcoe/fcoe_transport.c
> index a20ddc301c89e..6e187d0e71fd2 100644
> --- a/drivers/scsi/fcoe/fcoe_transport.c
> +++ b/drivers/scsi/fcoe/fcoe_transport.c
> @@ -382,6 +382,7 @@ EXPORT_SYMBOL_GPL(fcoe_clean_pending_queue);
>   /**
>    * fcoe_check_wait_queue() - Attempt to clear the transmit backlog
>    * @lport: The local port whose backlog is to be cleared
> + * @skb: The received FIP packet
>    *
>    * This empties the wait_queue, dequeues the head of the wait_queue queue
>    * and calls fcoe_start_io() for each packet. If all skb have been
> @@ -439,7 +440,7 @@ EXPORT_SYMBOL_GPL(fcoe_check_wait_queue);
>   
>   /**
>    * fcoe_queue_timer() - The fcoe queue timer
> - * @lport: The local port
> + * @t: Timer context use to obtain the FCoE port
>    *
>    * Calls fcoe_check_wait_queue on timeout
>    */
> @@ -672,6 +673,7 @@ static void fcoe_del_netdev_mapping(struct net_device *netdev)
>   /**
>    * fcoe_netdev_map_lookup - find the fcoe transport that matches the netdev on which
>    * it was created
> + * @netdev: The net device that the FCoE interface is on
>    *
>    * Returns : ptr to the fcoe transport that supports this netdev or NULL
>    * if not found.
Reviewed-by: Hannes Reinecke <hare@xxxxxxx>

Cheers,

Hannes
--
Dr. Hannes Reinecke            Teamlead Storage & Networking
hare@xxxxxxx                               +49 911 74053 688
SUSE Software Solutions GmbH, Maxfeldstr. 5, 90409 NÃrnberg
HRB 36809 (AG NÃrnberg), GeschÃftsfÃhrer: Felix ImendÃrffer