| Message ID | 20200713074645.126138-5-lee.jones@linaro.org (mailing list archive) |
|---|---|
| State | Accepted |
| Headers | show |
| Series | Fix a bunch more SCSI related W=1 warnings | expand |
On 7/13/20 9:46 AM, Lee Jones wrote: > 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' > > Cc: Hannes Reinecke <hare@suse.de> > Signed-off-by: Lee Jones <lee.jones@linaro.org> > --- > drivers/scsi/fcoe/fcoe.c | 10 ++++------ > 1 file changed, 4 insertions(+), 6 deletions(-) > > diff --git a/drivers/scsi/fcoe/fcoe.c b/drivers/scsi/fcoe/fcoe.c > index cb41d166e0c0f..0f9274960dc6b 100644 > --- a/drivers/scsi/fcoe/fcoe.c > +++ b/drivers/scsi/fcoe/fcoe.c > @@ -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, > I'd rather convert this and the fcoe_netdev_features_change to proper kerneldocs: diff --git a/drivers/scsi/fcoe/fcoe.c b/drivers/scsi/fcoe/fcoe.c index cb41d166e0c0..151fe4c53b07 100644 --- a/drivers/scsi/fcoe/fcoe.c +++ b/drivers/scsi/fcoe/fcoe.c @@ -646,8 +646,12 @@ static int fcoe_lport_config(struct fc_lport *lport) } /** - * fcoe_netdev_features_change - Updates the lport's offload flags based - * on the LLD netdev's FCoE feature flags + * fcoe_netdev_features_change - Updates the lport's offload flags + * @lport: The local port that is associated with the net device + * @netdev: The associated net device + * + * Update the @lport offload flags based on the FCoE feature flags + * from the LLD @netdev. */ static void fcoe_netdev_features_change(struct fc_lport *lport, struct net_device *netdev) @@ -2611,6 +2615,13 @@ static void fcoe_logo_resp(struct fc_seq *seq, struct fc_frame *fp, void *arg) /** * fcoe_elsct_send - FCoE specific ELS handler + * @lport: Local port + * @did: Destination ID + * @fp: FCoE frame + * @op: ELS operation + * @resp: Response callback + * @arg: Argument for the response callback + * @timeout: Timeout for the ELS response * * This does special case handling of FIP encapsualted ELS exchanges for FCoE, * using FCoE specific response handlers and passing the FIP controller as Cheers, Hannes
On Tue, 14 Jul 2020, Hannes Reinecke wrote: > On 7/13/20 9:46 AM, Lee Jones wrote: > > 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' > > > > Cc: Hannes Reinecke <hare@suse.de> > > Signed-off-by: Lee Jones <lee.jones@linaro.org> > > --- > > drivers/scsi/fcoe/fcoe.c | 10 ++++------ > > 1 file changed, 4 insertions(+), 6 deletions(-) > > > > diff --git a/drivers/scsi/fcoe/fcoe.c b/drivers/scsi/fcoe/fcoe.c > > index cb41d166e0c0f..0f9274960dc6b 100644 > > --- a/drivers/scsi/fcoe/fcoe.c > > +++ b/drivers/scsi/fcoe/fcoe.c > > @@ -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, > > > I'd rather convert this and the fcoe_netdev_features_change to proper > kerneldocs: > > diff --git a/drivers/scsi/fcoe/fcoe.c b/drivers/scsi/fcoe/fcoe.c > index cb41d166e0c0..151fe4c53b07 100644 > --- a/drivers/scsi/fcoe/fcoe.c > +++ b/drivers/scsi/fcoe/fcoe.c > @@ -646,8 +646,12 @@ static int fcoe_lport_config(struct fc_lport *lport) > } > > /** > - * fcoe_netdev_features_change - Updates the lport's offload flags based > - * on the LLD netdev's FCoE feature flags > + * fcoe_netdev_features_change - Updates the lport's offload flags > + * @lport: The local port that is associated with the net device > + * @netdev: The associated net device > + * > + * Update the @lport offload flags based on the FCoE feature flags > + * from the LLD @netdev. > */ > static void fcoe_netdev_features_change(struct fc_lport *lport, > struct net_device *netdev) > @@ -2611,6 +2615,13 @@ static void fcoe_logo_resp(struct fc_seq *seq, struct > fc_frame *fp, void *arg) > > /** > * fcoe_elsct_send - FCoE specific ELS handler > + * @lport: Local port > + * @did: Destination ID > + * @fp: FCoE frame > + * @op: ELS operation > + * @resp: Response callback > + * @arg: Argument for the response callback > + * @timeout: Timeout for the ELS response > * > * This does special case handling of FIP encapsualted ELS exchanges for > FCoE, > * using FCoE specific response handlers and passing the FIP controller as I don't want to steal your work. Why don't you send this and a follow-up to fix the broken header for fcoe_ctlr_disc_start() as follow-ups? It also saves me from having to submit a v3 of this entire set.
On 7/14/20 9:58 AM, Lee Jones wrote: > On Tue, 14 Jul 2020, Hannes Reinecke wrote: > >> On 7/13/20 9:46 AM, Lee Jones wrote: >>> 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' >>> >>> Cc: Hannes Reinecke <hare@suse.de> >>> Signed-off-by: Lee Jones <lee.jones@linaro.org> >>> --- >>> drivers/scsi/fcoe/fcoe.c | 10 ++++------ >>> 1 file changed, 4 insertions(+), 6 deletions(-) >>> >>> diff --git a/drivers/scsi/fcoe/fcoe.c b/drivers/scsi/fcoe/fcoe.c >>> index cb41d166e0c0f..0f9274960dc6b 100644 >>> --- a/drivers/scsi/fcoe/fcoe.c >>> +++ b/drivers/scsi/fcoe/fcoe.c >>> @@ -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, >>> >> I'd rather convert this and the fcoe_netdev_features_change to proper >> kerneldocs: >> >> diff --git a/drivers/scsi/fcoe/fcoe.c b/drivers/scsi/fcoe/fcoe.c >> index cb41d166e0c0..151fe4c53b07 100644 >> --- a/drivers/scsi/fcoe/fcoe.c >> +++ b/drivers/scsi/fcoe/fcoe.c >> @@ -646,8 +646,12 @@ static int fcoe_lport_config(struct fc_lport *lport) >> } >> >> /** >> - * fcoe_netdev_features_change - Updates the lport's offload flags based >> - * on the LLD netdev's FCoE feature flags >> + * fcoe_netdev_features_change - Updates the lport's offload flags >> + * @lport: The local port that is associated with the net device >> + * @netdev: The associated net device >> + * >> + * Update the @lport offload flags based on the FCoE feature flags >> + * from the LLD @netdev. >> */ >> static void fcoe_netdev_features_change(struct fc_lport *lport, >> struct net_device *netdev) >> @@ -2611,6 +2615,13 @@ static void fcoe_logo_resp(struct fc_seq *seq, struct >> fc_frame *fp, void *arg) >> >> /** >> * fcoe_elsct_send - FCoE specific ELS handler >> + * @lport: Local port >> + * @did: Destination ID >> + * @fp: FCoE frame >> + * @op: ELS operation >> + * @resp: Response callback >> + * @arg: Argument for the response callback >> + * @timeout: Timeout for the ELS response >> * >> * This does special case handling of FIP encapsualted ELS exchanges for >> FCoE, >> * using FCoE specific response handlers and passing the FIP controller as > > I don't want to steal your work. > > Why don't you send this and a follow-up to fix the broken header for > fcoe_ctlr_disc_start() as follow-ups? > > It also saves me from having to submit a v3 of this entire set. > Okay, not a problem. So you can add: Reviewed-by: Hannes Reinecke <hare@suse.de> Cheers, Hannes
diff --git a/drivers/scsi/fcoe/fcoe.c b/drivers/scsi/fcoe/fcoe.c index cb41d166e0c0f..0f9274960dc6b 100644 --- a/drivers/scsi/fcoe/fcoe.c +++ b/drivers/scsi/fcoe/fcoe.c @@ -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,
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' Cc: Hannes Reinecke <hare@suse.de> Signed-off-by: Lee Jones <lee.jones@linaro.org> --- drivers/scsi/fcoe/fcoe.c | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-)