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

scsi: libfc: Repair function parameter documentation 

Either misdocumentation and/or bitrot.

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

 drivers/scsi/libfc/fc_lport.c:412: warning: Function parameter or member 'in_fp' not described in 'fc_lport_recv_echo_req'
 drivers/scsi/libfc/fc_lport.c:412: warning: Excess function parameter 'fp' description in 'fc_lport_recv_echo_req'
 drivers/scsi/libfc/fc_lport.c:447: warning: Function parameter or member 'in_fp' not described in 'fc_lport_recv_rnid_req'
 drivers/scsi/libfc/fc_lport.c:447: warning: Excess function parameter 'fp' description in 'fc_lport_recv_rnid_req'
 drivers/scsi/libfc/fc_lport.c:1330: warning: Function parameter or member 'state' not described in 'fc_lport_enter_ns'
 drivers/scsi/libfc/fc_lport.c:1428: warning: Function parameter or member 'state' not described in 'fc_lport_enter_ms'
 drivers/scsi/libfc/fc_lport.c:1939: warning: Function parameter or member 'tov' not described in 'fc_lport_els_request'

Link: https://lore.kernel.org/r/20200713074645.126138-11-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 c6e2f4bd

drivers/scsi/libfc/fc_lport.c

+5 −2
Original line number Diff line number Diff line
@@ -405,7 +405,7 @@ static void fc_lport_recv_rlir_req(struct fc_lport *lport, struct fc_frame *fp) 
/**

 * fc_lport_recv_echo_req() - Handle received ECHO request

 * @lport: The local port receiving the ECHO

 * @fp:	   ECHO request frame

 * @in_fp: ECHO request frame

 */

static void fc_lport_recv_echo_req(struct fc_lport *lport,

				   struct fc_frame *in_fp)
@@ -440,7 +440,7 @@ static void fc_lport_recv_echo_req(struct fc_lport *lport, 
/**

 * fc_lport_recv_rnid_req() - Handle received Request Node ID data request

 * @lport: The local port receiving the RNID

 * @fp:	   The RNID request frame

 * @in_fp: The RNID request frame

 */

static void fc_lport_recv_rnid_req(struct fc_lport *lport,

				   struct fc_frame *in_fp)
@@ -1325,6 +1325,7 @@ static void fc_lport_enter_scr(struct fc_lport *lport) 
/**

 * fc_lport_enter_ns() - register some object with the name server

 * @lport: Fibre Channel local port to register

 * @state: Local port state

 */

static void fc_lport_enter_ns(struct fc_lport *lport, enum fc_lport_state state)

{
@@ -1423,6 +1424,7 @@ static void fc_lport_enter_dns(struct fc_lport *lport) 
/**

 * fc_lport_enter_ms() - management server commands

 * @lport: Fibre Channel local port to register

 * @state: Local port state

 */

static void fc_lport_enter_ms(struct fc_lport *lport, enum fc_lport_state state)

{
@@ -1932,6 +1934,7 @@ static void fc_lport_bsg_resp(struct fc_seq *sp, struct fc_frame *fp, 
 * @job:   The BSG Passthrough job

 * @lport: The local port sending the request

 * @did:   The destination port id

 * @tov:   The timeout period (in ms)

 */

static int fc_lport_els_request(struct bsg_job *job,

				struct fc_lport *lport,