github-mirror/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2026-05-30 01:53:29 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity Graph

scsi: scsi_error: Add kernel-doc for exported functions

Browse Source 
Convert scsi_report_bus_reset() and scsi_report_device_reset() to
kernel-doc since they are exported. This allows them to be part of the
driver-api/scsi.rst docbook.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Link: https://lore.kernel.org/r/20241212205217.597844-2-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>
This commit is contained in:
Randy Dunlap 2024-12-12 12:52:13 -08:00 committed by Martin K. Petersen
parent 29081c21a7
commit 20b98768c2
1 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
drivers/scsi/scsi_error.c
View File

@ -2363,14 +2363,14 @@ int scsi_error_handler(void *data)
return 0;
}
/*
* Function: scsi_report_bus_reset()
/**
* scsi_report_bus_reset() - report bus reset observed
*
* Purpose: Utility function used by low-level drivers to report that
* they have observed a bus reset on the bus being handled.
* Utility function used by low-level drivers to report that
* they have observed a bus reset on the bus being handled.
*
* Arguments: shost - Host in question
* channel - channel on which reset was observed.
* @shost: Host in question
* @channel: channel on which reset was observed.
*
* Returns: Nothing
*
@ -2395,15 +2395,15 @@ void scsi_report_bus_reset(struct Scsi_Host *shost, int channel)
}
EXPORT_SYMBOL(scsi_report_bus_reset);
/*
* Function: scsi_report_device_reset()
/**
* scsi_report_device_reset() - report device reset observed
*
* Purpose: Utility function used by low-level drivers to report that
* they have observed a device reset on the device being handled.
* Utility function used by low-level drivers to report that
* they have observed a device reset on the device being handled.
*
* Arguments: shost - Host in question
* channel - channel on which reset was observed
* target - target on which reset was observed
* @shost: Host in question
* @channel: channel on which reset was observed
* @target: target on which reset was observed
*
* Returns: Nothing
*