Skip to content

Commit 20b9876

Browse files
rddunlapmartinkpetersen
authored andcommitted
scsi: scsi_error: Add kernel-doc for exported functions
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 <[email protected]> Link: https://lore.kernel.org/r/[email protected] CC: James E.J. Bottomley <[email protected]> CC: Martin K. Petersen <[email protected]> Signed-off-by: Martin K. Petersen <[email protected]>
1 parent 29081c2 commit 20b9876

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

drivers/scsi/scsi_error.c

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2363,14 +2363,14 @@ int scsi_error_handler(void *data)
23632363
return 0;
23642364
}
23652365

2366-
/*
2367-
* Function: scsi_report_bus_reset()
2366+
/**
2367+
* scsi_report_bus_reset() - report bus reset observed
23682368
*
2369-
* Purpose: Utility function used by low-level drivers to report that
2370-
* they have observed a bus reset on the bus being handled.
2369+
* Utility function used by low-level drivers to report that
2370+
* they have observed a bus reset on the bus being handled.
23712371
*
2372-
* Arguments: shost - Host in question
2373-
* channel - channel on which reset was observed.
2372+
* @shost: Host in question
2373+
* @channel: channel on which reset was observed.
23742374
*
23752375
* Returns: Nothing
23762376
*
@@ -2395,15 +2395,15 @@ void scsi_report_bus_reset(struct Scsi_Host *shost, int channel)
23952395
}
23962396
EXPORT_SYMBOL(scsi_report_bus_reset);
23972397

2398-
/*
2399-
* Function: scsi_report_device_reset()
2398+
/**
2399+
* scsi_report_device_reset() - report device reset observed
24002400
*
2401-
* Purpose: Utility function used by low-level drivers to report that
2402-
* they have observed a device reset on the device being handled.
2401+
* Utility function used by low-level drivers to report that
2402+
* they have observed a device reset on the device being handled.
24032403
*
2404-
* Arguments: shost - Host in question
2405-
* channel - channel on which reset was observed
2406-
* target - target on which reset was observed
2404+
* @shost: Host in question
2405+
* @channel: channel on which reset was observed
2406+
* @target: target on which reset was observed
24072407
*
24082408
* Returns: Nothing
24092409
*

0 commit comments

Comments
 (0)