Commit f2db5efe authored Jul 13, 2020 by Lee Jones Committed by Martin K. Petersen Jul 15, 2020

scsi: fcoe: Correct some kernel-doc issues

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'

Link: https://lore.kernel.org/r/20200713074645.126138-7-lee.jones@linaro.org

Cc: Hannes Reinecke <hare@suse.de>
Reviewed-by: Hannes Reinecke <hare@suse.de>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
Signed-off-by: Martin K. Petersen <martin.petersen@oracle.com>

parent 30526523

drivers/scsi/fcoe/fcoe_transport.c

+3 −1

Original line number	Diff line number	Diff line
		@@ -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.