[09/10] scsi: libfc: fc_disc: Fix-up some incorrectly referenced function parameters

Message ID 20200707140055.2956235-10-lee.jones@linaro.org
State New
Headers show
Series
  • Fix a bunch SCSI related W=1 warnings
Related show

Commit Message

Lee Jones July 7, 2020, 2 p.m.
Fixes the following W=1 kernel build warning(s):

 drivers/scsi/libfc/fc_disc.c:343: warning: Function parameter or member 'disc' not described in 'fc_disc_gpn_ft_req'
 drivers/scsi/libfc/fc_disc.c:343: warning: Excess function parameter 'lport' description in 'fc_disc_gpn_ft_req'
 drivers/scsi/libfc/fc_disc.c:380: warning: Function parameter or member 'disc' not described in 'fc_disc_gpn_ft_parse'
 drivers/scsi/libfc/fc_disc.c:380: warning: Excess function parameter 'lport' description in 'fc_disc_gpn_ft_parse'
 drivers/scsi/libfc/fc_disc.c:498: warning: Function parameter or member 'disc_arg' not described in 'fc_disc_gpn_ft_resp'
 drivers/scsi/libfc/fc_disc.c:498: warning: Excess function parameter 'lp_arg' description in 'fc_disc_gpn_ft_resp'

Cc: Hannes Reinecke <hare@suse.de>
Signed-off-by: Lee Jones <lee.jones@linaro.org>

---
 drivers/scsi/libfc/fc_disc.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

-- 
2.25.1

Comments

Hannes Reinecke July 8, 2020, 6:30 a.m. | #1
On 7/7/20 4:00 PM, Lee Jones wrote:
> Fixes the following W=1 kernel build warning(s):

> 

>   drivers/scsi/libfc/fc_disc.c:343: warning: Function parameter or member 'disc' not described in 'fc_disc_gpn_ft_req'

>   drivers/scsi/libfc/fc_disc.c:343: warning: Excess function parameter 'lport' description in 'fc_disc_gpn_ft_req'

>   drivers/scsi/libfc/fc_disc.c:380: warning: Function parameter or member 'disc' not described in 'fc_disc_gpn_ft_parse'

>   drivers/scsi/libfc/fc_disc.c:380: warning: Excess function parameter 'lport' description in 'fc_disc_gpn_ft_parse'

>   drivers/scsi/libfc/fc_disc.c:498: warning: Function parameter or member 'disc_arg' not described in 'fc_disc_gpn_ft_resp'

>   drivers/scsi/libfc/fc_disc.c:498: warning: Excess function parameter 'lp_arg' description in 'fc_disc_gpn_ft_resp'

> 

> Cc: Hannes Reinecke <hare@suse.de>

> Signed-off-by: Lee Jones <lee.jones@linaro.org>

> ---

>   drivers/scsi/libfc/fc_disc.c | 6 +++---

>   1 file changed, 3 insertions(+), 3 deletions(-)

> 

> diff --git a/drivers/scsi/libfc/fc_disc.c b/drivers/scsi/libfc/fc_disc.c

> index 2b865c6423e29..428f40cfd1c36 100644

> --- a/drivers/scsi/libfc/fc_disc.c

> +++ b/drivers/scsi/libfc/fc_disc.c

> @@ -337,7 +337,7 @@ static void fc_disc_error(struct fc_disc *disc, struct fc_frame *fp)

>   

>   /**

>    * fc_disc_gpn_ft_req() - Send Get Port Names by FC-4 type (GPN_FT) request

> - * @lport: The discovery context

> + * @disc: The discovery context

>    */

>   static void fc_disc_gpn_ft_req(struct fc_disc *disc)

>   {

> @@ -370,7 +370,7 @@ static void fc_disc_gpn_ft_req(struct fc_disc *disc)

>   

>   /**

>    * fc_disc_gpn_ft_parse() - Parse the body of the dNS GPN_FT response.

> - * @lport: The local port the GPN_FT was received on

> + * @disc:  The descovery context

>    * @buf:   The GPN_FT response buffer

>    * @len:   The size of response buffer

>    *

> @@ -488,7 +488,7 @@ static void fc_disc_timeout(struct work_struct *work)

>    * fc_disc_gpn_ft_resp() - Handle a response frame from Get Port Names (GPN_FT)

>    * @sp:	    The sequence that the GPN_FT response was received on

>    * @fp:	    The GPN_FT response frame

> - * @lp_arg: The discovery context

> + * @disc_arg: The discovery context

>    *

>    * Locking Note: This function is called without disc mutex held, and

>    *		 should do all its processing with the mutex held

> 

Reviewed-by: Hannes Reinecke <hare@suse.de>


Cheers,

Hannes
-- 
Dr. Hannes Reinecke            Teamlead Storage & Networking
hare@suse.de                               +49 911 74053 688
SUSE Software Solutions GmbH, Maxfeldstr. 5, 90409 Nürnberg
HRB 36809 (AG Nürnberg), Geschäftsführer: Felix Imendörffer
Johannes Thumshirn July 8, 2020, 7:34 a.m. | #2
On 07/07/2020 16:01, Lee Jones wrote:
> + * @disc:  The descovery context

s/descovery/discovery
Lee Jones July 8, 2020, 7:46 a.m. | #3
On Wed, 08 Jul 2020, Johannes Thumshirn wrote:

> On 07/07/2020 16:01, Lee Jones wrote:

> > + * @disc:  The descovery context

> 

> s/descovery/discovery


Ah yes.  I can't even blame copy/paste for this!

I think this patch has been applied.  I will send up a follow-up.

Thank you!

-- 
Lee Jones [李琼斯]
Senior Technical Lead - Developer Services
Linaro.org │ Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog

Patch

diff --git a/drivers/scsi/libfc/fc_disc.c b/drivers/scsi/libfc/fc_disc.c
index 2b865c6423e29..428f40cfd1c36 100644
--- a/drivers/scsi/libfc/fc_disc.c
+++ b/drivers/scsi/libfc/fc_disc.c
@@ -337,7 +337,7 @@  static void fc_disc_error(struct fc_disc *disc, struct fc_frame *fp)
 
 /**
  * fc_disc_gpn_ft_req() - Send Get Port Names by FC-4 type (GPN_FT) request
- * @lport: The discovery context
+ * @disc: The discovery context
  */
 static void fc_disc_gpn_ft_req(struct fc_disc *disc)
 {
@@ -370,7 +370,7 @@  static void fc_disc_gpn_ft_req(struct fc_disc *disc)
 
 /**
  * fc_disc_gpn_ft_parse() - Parse the body of the dNS GPN_FT response.
- * @lport: The local port the GPN_FT was received on
+ * @disc:  The descovery context
  * @buf:   The GPN_FT response buffer
  * @len:   The size of response buffer
  *
@@ -488,7 +488,7 @@  static void fc_disc_timeout(struct work_struct *work)
  * fc_disc_gpn_ft_resp() - Handle a response frame from Get Port Names (GPN_FT)
  * @sp:	    The sequence that the GPN_FT response was received on
  * @fp:	    The GPN_FT response frame
- * @lp_arg: The discovery context
+ * @disc_arg: The discovery context
  *
  * Locking Note: This function is called without disc mutex held, and
  *		 should do all its processing with the mutex held