Commit 8d523f0f authored by Randy Dunlap's avatar Randy Dunlap Committed by Martin K. Petersen

scsi: core: Add function return kernel-doc for 2 functions

Add missing function return values to prevent kernel-doc warnings:

scsi.h:75: warning: No description found for return value of 'scsi_status_is_check_condition'
scsi.h:202: warning: No description found for return value of 'scsi_status_is_good'
Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Link: https://lore.kernel.org/r/20240408025425.18778-7-rdunlap@infradead.orgReviewed-by: default avatarBart Van Assche <bvanassche@acm.org>
Signed-off-by: default avatarMartin K. Petersen <martin.petersen@oracle.com>
parent d9c91182
...@@ -69,7 +69,7 @@ static inline int scsi_is_wlun(u64 lun) ...@@ -69,7 +69,7 @@ static inline int scsi_is_wlun(u64 lun)
* @status: the status passed up from the driver (including host and * @status: the status passed up from the driver (including host and
* driver components) * driver components)
* *
* This returns true if the status code is SAM_STAT_CHECK_CONDITION. * Returns: %true if the status code is SAM_STAT_CHECK_CONDITION.
*/ */
static inline int scsi_status_is_check_condition(int status) static inline int scsi_status_is_check_condition(int status)
{ {
...@@ -189,12 +189,13 @@ enum scsi_disposition { ...@@ -189,12 +189,13 @@ enum scsi_disposition {
/* Used to obtain the PCI location of a device */ /* Used to obtain the PCI location of a device */
#define SCSI_IOCTL_GET_PCI 0x5387 #define SCSI_IOCTL_GET_PCI 0x5387
/** scsi_status_is_good - check the status return. /**
* scsi_status_is_good - check the status return.
* *
* @status: the status passed up from the driver (including host and * @status: the status passed up from the driver (including host and
* driver components) * driver components)
* *
* This returns true for known good conditions that may be treated as * Returns: %true for known good conditions that may be treated as
* command completed normally * command completed normally
*/ */
static inline bool scsi_status_is_good(int status) static inline bool scsi_status_is_good(int status)
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment