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>,
Sagi Grimberg <sagi@grimberg.me>,
Max Gurtovoy <mgurtovoy@nvidia.com>,
linux-rdma@vger.kernel.org, target-devel@vger.kernel.org
Subject: [PATCH 4/8] scsi: iser: fix @read_stag kernel-doc warning
Date: Sun, 7 Apr 2024 19:54:21 -0700 [thread overview]
Message-ID: <20240408025425.18778-5-rdunlap@infradead.org> (raw)
In-Reply-To: <20240408025425.18778-1-rdunlap@infradead.org>
Correct kernel-doc comments for struct iser_ctrl to prevent warnings:
iser.h:76: warning: Function parameter or struct member 'read_stag' not described in 'iser_ctrl'
iser.h:76: warning: Excess struct member 'reaf_stag' description in 'iser_ctrl'
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
Cc: Sagi Grimberg <sagi@grimberg.me>
Cc: Max Gurtovoy <mgurtovoy@nvidia.com>
Cc: linux-rdma@vger.kernel.org
Cc: target-devel@vger.kernel.org
include/scsi/iser.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff -- a/include/scsi/iser.h b/include/scsi/iser.h
--- a/include/scsi/iser.h
+++ b/include/scsi/iser.h
@@ -63,7 +63,7 @@ struct iser_cm_hdr {
* @rsvd: reserved
* @write_stag: write rkey
* @write_va: write virtual address
- * @reaf_stag: read rkey
+ * @read_stag: read rkey
* @read_va: read virtual address
*/
struct iser_ctrl {
next prev parent reply other threads:[~2024-04-08 2:54 UTC|newest]
Thread overview: 6+ 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 ` Randy Dunlap [this message]
2024-04-08 6:35 ` [PATCH 4/8] scsi: iser: fix @read_stag kernel-doc warning Sagi Grimberg
2024-04-08 7:43 ` Max Gurtovoy
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-5-rdunlap@infradead.org \
--to=rdunlap@infradead.org \
--cc=jejb@linux.ibm.com \
--cc=linux-rdma@vger.kernel.org \
--cc=linux-scsi@vger.kernel.org \
--cc=martin.petersen@oracle.com \
--cc=mgurtovoy@nvidia.com \
--cc=sagi@grimberg.me \
--cc=target-devel@vger.kernel.org \
/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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).