[11/30] scsi: libfc: fc_rport: Fix a couple of misdocumented function parameters

Message ID 20200708120221.3386672-12-lee.jones@linaro.org
State Superseded
Headers show
Series
  • Fix a bunch more SCSI related W=1 warnings
Related show

Commit Message

Lee Jones July 8, 2020, 12:02 p.m.
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 <hare@suse.de>
Signed-off-by: Lee Jones <lee.jones@linaro.org>

---
 drivers/scsi/libfc/fc_rport.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

-- 
2.25.1

Comments

Johannes Thumshirn July 8, 2020, 12:15 p.m. | #1
On 08/07/2020 14:04, Lee Jones wrote:
> @@ -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
> + * @rport_arg: The local port
>   */
>  static void fc_rport_logo_resp(struct fc_seq *sp, struct fc_frame *fp,
>  			       void *rdata_arg)

That doesn't look correct, s/rport_arg/rdata_arg/ and an rport is a remote port not a local port.
Lee Jones July 8, 2020, 12:23 p.m. | #2
On Wed, 08 Jul 2020, Johannes Thumshirn wrote:

> On 08/07/2020 14:04, Lee Jones wrote:

> > @@ -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

> > + * @rport_arg: The local port

> >   */

> >  static void fc_rport_logo_resp(struct fc_seq *sp, struct fc_frame *fp,

> >  			       void *rdata_arg)

> 

> That doesn't look correct, s/rport_arg/rdata_arg/ and an rport is a remote port not a local port.


That's interesting.  Looks like I fixed this later in the set.

-- 
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_rport.c b/drivers/scsi/libfc/fc_rport.c
index 278d15ff1c5ae..ea99e69d4d89c 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
+ * @rport_arg: The local port
  */
 static void fc_rport_logo_resp(struct fc_seq *sp, struct fc_frame *fp,
 			       void *rdata_arg)