summaryrefslogtreecommitdiffstats
path: root/include/scsi
diff options
context:
space:
mode:
authorRandy Dunlap <rdunlap@infradead.org>2024-04-07 19:54:24 -0700
committerMartin K. Petersen <martin.petersen@oracle.com>2024-04-08 22:10:06 -0400
commit007c04e535262417f8206b1bc0aaf1744467430c (patch)
tree2227b0311a72dc5c8e653b20dcf6defc5ae86d3b /include/scsi
parent8d523f0f5383a4f6ae74b6ccf3e0ec953a56dec6 (diff)
downloadlinux-007c04e535262417f8206b1bc0aaf1744467430c.tar.gz
linux-007c04e535262417f8206b1bc0aaf1744467430c.tar.bz2
linux-007c04e535262417f8206b1bc0aaf1744467430c.zip
scsi: scsi_transport_fc: Add kernel-doc for function return
Add function return value to prevent a kernel-doc warning: scsi_transport_fc.h:780: warning: No description found for return value of 'fc_remote_port_chkready' Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Link: https://lore.kernel.org/r/20240408025425.18778-8-rdunlap@infradead.org Signed-off-by: Martin K. Petersen <martin.petersen@oracle.com>
Diffstat (limited to 'include/scsi')
-rw-r--r--include/scsi/scsi_transport_fc.h5
1 files changed, 2 insertions, 3 deletions
diff --git a/include/scsi/scsi_transport_fc.h b/include/scsi/scsi_transport_fc.h
index 483513c57597..ebb1bd565103 100644
--- a/include/scsi/scsi_transport_fc.h
+++ b/include/scsi/scsi_transport_fc.h
@@ -770,10 +770,9 @@ struct fc_function_template {
/**
* fc_remote_port_chkready - called to validate the remote port state
* prior to initiating io to the port.
- *
- * Returns a scsi result code that can be returned by the LLDD.
- *
* @rport: remote port to be checked
+ *
+ * Returns: a scsi result code that can be returned by the LLDD.
**/
static inline int
fc_remote_port_chkready(struct fc_rport *rport)