Skip to content

Commit a2530eb

Browse files
rddunlapmartinkpetersen
authored andcommitted
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: Randy Dunlap <rdunlap@infradead.org> Link: https://lore.kernel.org/r/20240408025425.18778-9-rdunlap@infradead.org Reviewed-by: Bart Van Assche <bvanassche@acm.org> Signed-off-by: Martin K. Petersen <martin.petersen@oracle.com>
1 parent 007c04e commit a2530eb

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

include/scsi/scsi_transport_srp.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ struct srp_rport {
7474
};
7575

7676
/**
77-
* struct srp_function_template
77+
* struct srp_function_template - template for SRP initiator drivers
7878
*
7979
* Fields that are only relevant for SRP initiator drivers:
8080
* @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);
124124
* srp_chkready() - evaluate the transport layer state before I/O
125125
* @rport: SRP target port pointer.
126126
*
127-
* Returns a SCSI result code that can be returned by the LLD queuecommand()
127+
* Returns: a SCSI result code that can be returned by the LLD queuecommand()
128128
* implementation. The role of this function is similar to that of
129129
* fc_remote_port_chkready().
130130
*/

0 commit comments

Comments
 (0)