From 007c04e535262417f8206b1bc0aaf1744467430c Mon Sep 17 00:00:00 2001
From: Randy Dunlap <rdunlap@infradead.org>
Date: Sun, 7 Apr 2024 19:54:24 -0700
Subject: [PATCH] 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>
---
include/scsi/scsi_transport_fc.h | 5 ++---
1 file changed, 2 insertions(+), 3 deletions(-)
diff --git a/include/scsi/scsi_transport_fc.h b/include/scsi/scsi_transport_fc.h
index 483513c575976..ebb1bd565103b 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)
--
2.30.2