summaryrefslogtreecommitdiffstats
path: root/include/scsi
diff options
context:
space:
mode:
authorRandy Dunlap <rdunlap@infradead.org>2024-04-07 19:54:23 -0700
committerMartin K. Petersen <martin.petersen@oracle.com>2024-04-08 22:10:06 -0400
commit8d523f0f5383a4f6ae74b6ccf3e0ec953a56dec6 (patch)
tree3f721fcf94f8ea526cc4217e7542684bc08fb81a /include/scsi
parentd9c91182414524f1fa0f30584eb90f8211724bdb (diff)
downloadlinux-8d523f0f5383a4f6ae74b6ccf3e0ec953a56dec6.tar.gz
linux-8d523f0f5383a4f6ae74b6ccf3e0ec953a56dec6.tar.bz2
linux-8d523f0f5383a4f6ae74b6ccf3e0ec953a56dec6.zip
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: Randy Dunlap <rdunlap@infradead.org> Link: https://lore.kernel.org/r/20240408025425.18778-7-rdunlap@infradead.org Reviewed-by: Bart Van Assche <bvanassche@acm.org> Signed-off-by: Martin K. Petersen <martin.petersen@oracle.com>
Diffstat (limited to 'include/scsi')
-rw-r--r--include/scsi/scsi.h7
1 files changed, 4 insertions, 3 deletions
diff --git a/include/scsi/scsi.h b/include/scsi/scsi.h
index 4498f845b112..d90645f06a3a 100644
--- a/include/scsi/scsi.h
+++ b/include/scsi/scsi.h
@@ -69,7 +69,7 @@ static inline int scsi_is_wlun(u64 lun)
* @status: the status passed up from the driver (including host and
* 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)
{
@@ -189,12 +189,13 @@ enum scsi_disposition {
/* Used to obtain the PCI location of a device */
#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
* 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
*/
static inline bool scsi_status_is_good(int status)