2020-07-13 07:48:03

by Lee Jones

[permalink] [raw]
Subject: [PATCH v2 11/29] scsi: libfc: fc_rport: Fix a couple of misdocumented function parameters

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

drivers/scsi/libfc/fc_rport.c:129: warning: Function parameter or member 'port_id' not described in 'fc_rport_create'
drivers/scsi/libfc/fc_rport.c:129: warning: Excess function parameter 'ids' description in 'fc_rport_create'
drivers/scsi/libfc/fc_rport.c:1452: warning: Function parameter or member 'rdata_arg' not described in 'fc_rport_logo_resp'
drivers/scsi/libfc/fc_rport.c:1452: warning: Excess function parameter 'lport_arg' description in 'fc_rport_logo_resp'

Cc: Hannes Reinecke <[email protected]>
Signed-off-by: Lee Jones <[email protected]>
---
drivers/scsi/libfc/fc_rport.c | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/scsi/libfc/fc_rport.c b/drivers/scsi/libfc/fc_rport.c
index 278d15ff1c5ae..18663a82865f9 100644
--- a/drivers/scsi/libfc/fc_rport.c
+++ b/drivers/scsi/libfc/fc_rport.c
@@ -121,7 +121,7 @@ EXPORT_SYMBOL(fc_rport_lookup);
/**
* fc_rport_create() - Create a new remote port
* @lport: The local port this remote port will be associated with
- * @ids: The identifiers for the new remote port
+ * @port_id: The identifiers for the new remote port
*
* The remote port will start in the INIT state.
*/
@@ -1445,7 +1445,7 @@ static void fc_rport_recv_rtv_req(struct fc_rport_priv *rdata,
* fc_rport_logo_resp() - Handler for logout (LOGO) responses
* @sp: The sequence the LOGO was on
* @fp: The LOGO response frame
- * @lport_arg: The local port
+ * @rdata_arg: The remote port
*/
static void fc_rport_logo_resp(struct fc_seq *sp, struct fc_frame *fp,
void *rdata_arg)
--
2.25.1


2020-07-14 07:06:18

by Hannes Reinecke

[permalink] [raw]
Subject: Re: [PATCH v2 11/29] scsi: libfc: fc_rport: Fix a couple of misdocumented function parameters

On 7/13/20 9:46 AM, Lee Jones wrote:
> Fixes the following W=1 kernel build warning(s):
>
> drivers/scsi/libfc/fc_rport.c:129: warning: Function parameter or member 'port_id' not described in 'fc_rport_create'
> drivers/scsi/libfc/fc_rport.c:129: warning: Excess function parameter 'ids' description in 'fc_rport_create'
> drivers/scsi/libfc/fc_rport.c:1452: warning: Function parameter or member 'rdata_arg' not described in 'fc_rport_logo_resp'
> drivers/scsi/libfc/fc_rport.c:1452: warning: Excess function parameter 'lport_arg' description in 'fc_rport_logo_resp'
>
> Cc: Hannes Reinecke <[email protected]>
> Signed-off-by: Lee Jones <[email protected]>
> ---
> drivers/scsi/libfc/fc_rport.c | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/drivers/scsi/libfc/fc_rport.c b/drivers/scsi/libfc/fc_rport.c
> index 278d15ff1c5ae..18663a82865f9 100644
> --- a/drivers/scsi/libfc/fc_rport.c
> +++ b/drivers/scsi/libfc/fc_rport.c
> @@ -121,7 +121,7 @@ EXPORT_SYMBOL(fc_rport_lookup);
> /**
> * fc_rport_create() - Create a new remote port
> * @lport: The local port this remote port will be associated with
> - * @ids: The identifiers for the new remote port
> + * @port_id: The identifiers for the new remote port
> *
> * The remote port will start in the INIT state.
> */
> @@ -1445,7 +1445,7 @@ static void fc_rport_recv_rtv_req(struct fc_rport_priv *rdata,
> * fc_rport_logo_resp() - Handler for logout (LOGO) responses
> * @sp: The sequence the LOGO was on
> * @fp: The LOGO response frame
> - * @lport_arg: The local port
> + * @rdata_arg: The remote port
> */
> static void fc_rport_logo_resp(struct fc_seq *sp, struct fc_frame *fp,
> void *rdata_arg)
>
Reviewed-by: Hannes Reinecke <[email protected]>

Cheers,

Hannes
--
Dr. Hannes Reinecke Teamlead Storage & Networking
[email protected] +49 911 74053 688
SUSE Software Solutions GmbH, Maxfeldstr. 5, 90409 Nürnberg
HRB 36809 (AG Nürnberg), Geschäftsführer: Felix Imendörffer