Minki/linux
1
0
Fork 1
mirror of https://github.com/torvalds/linux.git synced 2024-11-21 19:41:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
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>
This commit is contained in:
Randy Dunlap 2024-04-07 19:54:25 -07:00 committed by Martin K. Petersen
parent 007c04e535
commit a2530eb748
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
include/scsi/scsi_transport_srp.h
View File

@ -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);
* 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().
*/ */