All of lore.kernel.org
 help / color / mirror / Atom feed
From: Randy Dunlap <rdunlap@infradead.org>
To: linux-scsi@vger.kernel.org
Cc: Randy Dunlap <rdunlap@infradead.org>,
	"James E.J. Bottomley" <jejb@linux.ibm.com>,
	"Martin K. Petersen" <martin.petersen@oracle.com>
Subject: [PATCH 6/8] scsi: core: add function return kernel-doc for 2 functions
Date: Sun,  7 Apr 2024 19:54:23 -0700	[thread overview]
Message-ID: <20240408025425.18778-7-rdunlap@infradead.org> (raw)
In-Reply-To: <20240408025425.18778-1-rdunlap@infradead.org>

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>
---
Cc: "James E.J. Bottomley" <jejb@linux.ibm.com>
Cc: "Martin K. Petersen" <martin.petersen@oracle.com>
Cc: linux-scsi@vger.kernel.org

 include/scsi/scsi.h |    7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff -- a/include/scsi/scsi.h b/include/scsi/scsi.h
--- 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)

  parent reply	other threads:[~2024-04-08  2:54 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-04-08  2:54 [PATCH 0/8] scsi: documentation: clean up docs and fix kernel-doc Randy Dunlap
2024-04-08  2:54 ` [PATCH 1/8] scsi: documentation: clean up scsi_mid_low_api.rst Randy Dunlap
2024-04-08  2:54 ` [PATCH 2/8] scsi: documentation: clean up overview Randy Dunlap
2024-04-08  2:54 ` [PATCH 3/8] scsi: core: add kernel-doc for scsi_msg_to_host_byte() Randy Dunlap
2024-04-08 16:28   ` Bart Van Assche
2024-04-08  2:54 ` [PATCH 4/8] scsi: iser: fix @read_stag kernel-doc warning Randy Dunlap
2024-04-08  6:35   ` Sagi Grimberg
2024-04-08  7:43   ` Max Gurtovoy
2024-04-08  2:54 ` [PATCH 5/8] scsi: libfcoe: fix a slew of kernel-doc warnings Randy Dunlap
2024-04-08  2:54 ` Randy Dunlap [this message]
2024-04-08 16:29   ` [PATCH 6/8] scsi: core: add function return kernel-doc for 2 functions Bart Van Assche
2024-04-08  2:54 ` [PATCH 7/8] scsi: scsi_transport_fc: add kernel-doc for function return Randy Dunlap
2024-04-08  2:54 ` [PATCH 8/8] scsi: scsi_transport_srp: fix a couple of kernel-doc warnings Randy Dunlap
2024-04-08 16:30   ` Bart Van Assche
2024-04-09  2:10 ` [PATCH 0/8] scsi: documentation: clean up docs and fix kernel-doc Martin K. Petersen
2024-04-12  2:05 ` Martin K. Petersen

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240408025425.18778-7-rdunlap@infradead.org \
    --to=rdunlap@infradead.org \
    --cc=jejb@linux.ibm.com \
    --cc=linux-scsi@vger.kernel.org \
    --cc=martin.petersen@oracle.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.