diff mbox series

[8/8] scsi: scsi_transport_srp: fix a couple of kernel-doc warnings

Message ID 20240408025425.18778-9-rdunlap@infradead.org (mailing list archive)
State Accepted
Headers show
Series scsi: documentation: clean up docs and fix kernel-doc | expand

Commit Message

Randy Dunlap April 8, 2024, 2:54 a.m. UTC 
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>
---
Cc: "James E.J. Bottomley" <jejb@linux.ibm.com>
Cc: "Martin K. Petersen" <martin.petersen@oracle.com>
Cc: linux-scsi@vger.kernel.org
Cc: Bart Van Assche <bvanassche@acm.org>

 include/scsi/scsi_transport_srp.h |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Bart Van Assche April 8, 2024, 4:30 p.m. UTC | #1 
On 4/7/24 19:54, Randy Dunlap wrote:
> Add a struct short description and a function return value to prevent
> kernel-doc warnings:

Reviewed-by: Bart Van Assche <bvanassche@acm.org>
diff mbox series

Patch

diff -- a/include/scsi/scsi_transport_srp.h b/include/scsi/scsi_transport_srp.h
--- 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(s
  * 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().
  */