Commit a2530eb7 authored by Randy Dunlap's avatar Randy Dunlap Committed by Martin K. Petersen

scsi: scsi_transport_srp: Fix a couple of kernel-doc warnings

Add a struct short description and a function return value to prevent
kernel-doc warnings:

scsi_transport_srp.h:77: warning: missing initial short description on line:
 * struct srp_function_template
scsi_transport_srp.h:132: warning: No description found for return value of 'srp_chkready'
Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Link: https://lore.kernel.org/r/20240408025425.18778-9-rdunlap@infradead.orgReviewed-by: default avatarBart Van Assche <bvanassche@acm.org>
Signed-off-by: default avatarMartin K. Petersen <martin.petersen@oracle.com>
parent 007c04e5
...@@ -74,7 +74,7 @@ struct srp_rport { ...@@ -74,7 +74,7 @@ struct srp_rport {
}; };
/** /**
* struct srp_function_template * struct srp_function_template - template for SRP initiator drivers
* *
* Fields that are only relevant for SRP initiator drivers: * Fields that are only relevant for SRP initiator drivers:
* @has_rport_state: Whether or not to create the state, fast_io_fail_tmo and * @has_rport_state: Whether or not to create the state, fast_io_fail_tmo and
...@@ -124,7 +124,7 @@ enum scsi_timeout_action srp_timed_out(struct scsi_cmnd *scmd); ...@@ -124,7 +124,7 @@ enum scsi_timeout_action srp_timed_out(struct scsi_cmnd *scmd);
* srp_chkready() - evaluate the transport layer state before I/O * srp_chkready() - evaluate the transport layer state before I/O
* @rport: SRP target port pointer. * @rport: SRP target port pointer.
* *
* Returns a SCSI result code that can be returned by the LLD queuecommand() * Returns: a SCSI result code that can be returned by the LLD queuecommand()
* implementation. The role of this function is similar to that of * implementation. The role of this function is similar to that of
* fc_remote_port_chkready(). * fc_remote_port_chkready().
*/ */
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment