Commit 54888649 authored by Lee Jones's avatar Lee Jones Committed by Martin K. Petersen
Browse files

scsi: fcoe: Fix various kernel-doc infringements 

A couple of headers make no attempt to document their associated function
parameters.  Others looks as if they are suffering with a little bitrot.

Fixes the following W=1 kernel build warning(s):

 drivers/scsi/fcoe/fcoe.c:654: warning: Function parameter or member 'lport' not described in 'fcoe_netdev_features_change'
 drivers/scsi/fcoe/fcoe.c:654: warning: Function parameter or member 'netdev' not described in 'fcoe_netdev_features_change'
 drivers/scsi/fcoe/fcoe.c:2039: warning: Function parameter or member 'ctlr_dev' not described in 'fcoe_ctlr_mode'
 drivers/scsi/fcoe/fcoe.c:2039: warning: Excess function parameter 'cdev' description in 'fcoe_ctlr_mode'
 drivers/scsi/fcoe/fcoe.c:2144: warning: Function parameter or member 'fcoe' not described in 'fcoe_dcb_create'
 drivers/scsi/fcoe/fcoe.c:2144: warning: Excess function parameter 'netdev' description in 'fcoe_dcb_create'
 drivers/scsi/fcoe/fcoe.c:2144: warning: Excess function parameter 'port' description in 'fcoe_dcb_create'
 drivers/scsi/fcoe/fcoe.c:2627: warning: Function parameter or member 'lport' not described in 'fcoe_elsct_send'
 drivers/scsi/fcoe/fcoe.c:2627: warning: Function parameter or member 'did' not described in 'fcoe_elsct_send'
 drivers/scsi/fcoe/fcoe.c:2627: warning: Function parameter or member 'fp' not described in 'fcoe_elsct_send'
 drivers/scsi/fcoe/fcoe.c:2627: warning: Function parameter or member 'op' not described in 'fcoe_elsct_send'
 drivers/scsi/fcoe/fcoe.c:2627: warning: Function parameter or member 'resp' not described in 'fcoe_elsct_send'
 drivers/scsi/fcoe/fcoe.c:2627: warning: Function parameter or member 'arg' not described in 'fcoe_elsct_send'
 drivers/scsi/fcoe/fcoe.c:2627: warning: Function parameter or member 'timeout' not described in 'fcoe_elsct_send'

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


Cc: Hannes Reinecke <hare@suse.de>
Reviewed-by: default avatarHannes Reinecke <hare@suse.de>
Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
Signed-off-by: default avatarMartin K. Petersen <martin.petersen@oracle.com>
parent ee9ec5c9

drivers/scsi/fcoe/fcoe.c

+4 −6
Original line number Diff line number Diff line
@@ -645,7 +645,7 @@ static int fcoe_lport_config(struct fc_lport *lport) 
	return 0;

}



/**

/*

 * fcoe_netdev_features_change - Updates the lport's offload flags based

 * on the LLD netdev's FCoE feature flags

 */
@@ -2029,7 +2029,7 @@ static int fcoe_ctlr_enabled(struct fcoe_ctlr_device *cdev) 


/**

 * fcoe_ctlr_mode() - Switch FIP mode

 * @cdev: The FCoE Controller that is being modified

 * @ctlr_dev: The FCoE Controller that is being modified

 *

 * When the FIP mode has been changed we need to update

 * the multicast addresses to ensure we get the correct
@@ -2136,9 +2136,7 @@ static bool fcoe_match(struct net_device *netdev) 


/**

 * fcoe_dcb_create() - Initialize DCB attributes and hooks

 * @netdev: The net_device object of the L2 link that should be queried

 * @port: The fcoe_port to bind FCoE APP priority with

 * @

 * @fcoe:   The new FCoE interface

 */

static void fcoe_dcb_create(struct fcoe_interface *fcoe)

{
@@ -2609,7 +2607,7 @@ static void fcoe_logo_resp(struct fc_seq *seq, struct fc_frame *fp, void *arg) 
	fc_lport_logo_resp(seq, fp, lport);

}



/**

/*

 * fcoe_elsct_send - FCoE specific ELS handler

 *

 * This does special case handling of FIP encapsualted ELS exchanges for FCoE,