diff options
| author |  Randy Dunlap <rdunlap@infradead.org>
| 2024-04-07 19:54:25 -0700 |
|---|---|---|
| committer |  Martin K. Petersen <martin.petersen@oracle.com>
| 2024-04-08 22:10:06 -0400 |
| commit | a2530eb748fff3966d3b20d1be81393fb403ec51 (patch) | |
| tree | 2f3a3848b878823fa29a9f1ba028d5e7231d39c0 /include/scsi | |
| parent | scsi: scsi_transport_fc: Add kernel-doc for function return (diff) | |
| download | linux-a2530eb748fff3966d3b20d1be81393fb403ec51.tar.gz linux-a2530eb748fff3966d3b20d1be81393fb403ec51.tar.bz2 linux-a2530eb748fff3966d3b20d1be81393fb403ec51.zip | |
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>
Diffstat (limited to 'include/scsi')
| -rw-r--r-- | include/scsi/scsi_transport_srp.h | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/include/scsi/scsi_transport_srp.h b/include/scsi/scsi_transport_srp.h index dfc78aa112ad..5b70b538447e 100644 --- a/include/scsi/scsi_transport_srp.h +++ b/include/scsi/scsi_transport_srp.h @@ -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: * @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 * @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 * fc_remote_port_chkready(). */ |