diff mbox series

[5/5] scsi: transports: fix kernel-doc for exported functions

Message ID 20241212205217.597844-6-rdunlap@infradead.org
State New
Headers show
Series scsi: fix kernel-doc for exported functions | expand

Commit Message

Randy Dunlap Dec. 12, 2024, 8:52 p.m. UTC 
Fix kernel-doc for sas_port_alloc(), sas_port_alloc_num(), and
spi_dv_device().
This allows them to be part of the SCSI driver-api docbook.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
CC: "James E.J. Bottomley" <James.Bottomley@HansenPartnership.com>
CC: "Martin K. Petersen" <martin.petersen@oracle.com>
---
 drivers/scsi/scsi_transport_sas.c |   10 ++++++----
 drivers/scsi/scsi_transport_spi.c |    3 ++-
 2 files changed, 8 insertions(+), 5 deletions(-)
diff mbox series

Patch

--- linux-next-20241212.orig/drivers/scsi/scsi_transport_sas.c
+++ linux-next-20241212/drivers/scsi/scsi_transport_sas.c
@@ -888,7 +888,8 @@  static void sas_port_delete_link(struct
 	sysfs_remove_link(&phy->dev.kobj, "port");
 }
 
-/** sas_port_alloc - allocate and initialize a SAS port structure
+/**
+ * sas_port_alloc - allocate and initialize a SAS port structure
  *
  * @parent:	parent device
  * @port_id:	port number
@@ -897,7 +898,7 @@  static void sas_port_delete_link(struct
  * below the device specified by @parent which must be either a Scsi_Host
  * or a sas_expander_device.
  *
- * Returns %NULL on error
+ * Returns: %NULL on error
  */
 struct sas_port *sas_port_alloc(struct device *parent, int port_id)
 {
@@ -932,7 +933,8 @@  struct sas_port *sas_port_alloc(struct d
 }
 EXPORT_SYMBOL(sas_port_alloc);
 
-/** sas_port_alloc_num - allocate and initialize a SAS port structure
+/**
+ * sas_port_alloc_num - allocate and initialize a SAS port structure
  *
  * @parent:	parent device
  *
@@ -942,7 +944,7 @@  EXPORT_SYMBOL(sas_port_alloc);
  * the device tree below the device specified by @parent which must be
  * either a Scsi_Host or a sas_expander_device.
  *
- * Returns %NULL on error
+ * Returns: %NULL on error
  */
 struct sas_port *sas_port_alloc_num(struct device *parent)
 {
--- linux-next-20241212.orig/drivers/scsi/scsi_transport_spi.c
+++ linux-next-20241212/drivers/scsi/scsi_transport_spi.c
@@ -985,7 +985,8 @@  spi_dv_device_internal(struct scsi_devic
 }
 
 
-/**	spi_dv_device - Do Domain Validation on the device
+/**
+ *	spi_dv_device - Do Domain Validation on the device
  *	@sdev:		scsi device to validate
  *
  *	Performs the domain validation on the given device in the