Skip to content

Commit d4842e5

Browse files
rddunlapmartinkpetersen
authored andcommitted
scsi: transport: sas: spi: Fix kernel-doc for exported functions
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>
1 parent d2f4084 commit d4842e5

File tree

2 files changed

+8
-5
lines changed

2 files changed

+8
-5
lines changed

drivers/scsi/scsi_transport_sas.c

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -888,7 +888,8 @@ static void sas_port_delete_link(struct sas_port *port,
888888
sysfs_remove_link(&phy->dev.kobj, "port");
889889
}
890890

891-
/** sas_port_alloc - allocate and initialize a SAS port structure
891+
/**
892+
* sas_port_alloc - allocate and initialize a SAS port structure
892893
*
893894
* @parent: parent device
894895
* @port_id: port number
@@ -897,7 +898,7 @@ static void sas_port_delete_link(struct sas_port *port,
897898
* below the device specified by @parent which must be either a Scsi_Host
898899
* or a sas_expander_device.
899900
*
900-
* Returns %NULL on error
901+
* Returns: %NULL on error
901902
*/
902903
struct sas_port *sas_port_alloc(struct device *parent, int port_id)
903904
{
@@ -932,7 +933,8 @@ struct sas_port *sas_port_alloc(struct device *parent, int port_id)
932933
}
933934
EXPORT_SYMBOL(sas_port_alloc);
934935

935-
/** sas_port_alloc_num - allocate and initialize a SAS port structure
936+
/**
937+
* sas_port_alloc_num - allocate and initialize a SAS port structure
936938
*
937939
* @parent: parent device
938940
*
@@ -942,7 +944,7 @@ EXPORT_SYMBOL(sas_port_alloc);
942944
* the device tree below the device specified by @parent which must be
943945
* either a Scsi_Host or a sas_expander_device.
944946
*
945-
* Returns %NULL on error
947+
* Returns: %NULL on error
946948
*/
947949
struct sas_port *sas_port_alloc_num(struct device *parent)
948950
{

drivers/scsi/scsi_transport_spi.c

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -985,7 +985,8 @@ spi_dv_device_internal(struct scsi_device *sdev, u8 *buffer)
985985
}
986986

987987

988-
/** spi_dv_device - Do Domain Validation on the device
988+
/**
989+
* spi_dv_device - Do Domain Validation on the device
989990
* @sdev: scsi device to validate
990991
*
991992
* Performs the domain validation on the given device in the

0 commit comments

Comments
 (0)