scsi: transport: sas: spi: Fix kernel-doc for exported functions
authorRandy Dunlap <rdunlap@infradead.org>
Thu, 12 Dec 2024 20:52:17 +0000 (12:52 -0800)
committerMartin K. Petersen <martin.petersen@oracle.com>
Fri, 10 Jan 2025 20:15:20 +0000 (15:15 -0500)
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>
Link: https://lore.kernel.org/r/20241212205217.597844-6-rdunlap@infradead.org
CC: James E.J. Bottomley <James.Bottomley@HansenPartnership.com>
CC: Martin K. Petersen <martin.petersen@oracle.com>
Signed-off-by: Martin K. Petersen <martin.petersen@oracle.com>
drivers/scsi/scsi_transport_sas.c
drivers/scsi/scsi_transport_spi.c

index 4e33f1661e4c1d8ae7bb0dac5023cc6422e8c44f..351b028ef8938ed44b14ce3445fd140ac0d86261 100644 (file)
@@ -888,7 +888,8 @@ static void sas_port_delete_link(struct sas_port *port,
        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 sas_port *port,
  * 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 device *parent, int port_id)
 }
 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)
 {
index 64852e6df3e327d97aa74d38f932e11551a69b41..fe47850a82587f567c3e89ee18c14ad966e0baa7 100644 (file)
@@ -985,7 +985,8 @@ spi_dv_device_internal(struct scsi_device *sdev, u8 *buffer)
 }
 
 
-/**    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