From: Randy Dunlap <rdunlap@infradead.org>
To: linux-kernel@vger.kernel.org
Cc: Randy Dunlap <rdunlap@infradead.org>,
Keith Busch <kbusch@kernel.org>, Jens Axboe <axboe@fb.com>,
Christoph Hellwig <hch@lst.de>, Sagi Grimberg <sagi@grimberg.me>,
linux-nvme@lists.infradead.org
Subject: [PATCH] nvme-tcp.h: correct kernel-doc comments
Date: Wed, 11 Mar 2026 22:14:31 -0700 [thread overview]
Message-ID: <20260312051431.684352-1-rdunlap@infradead.org> (raw)
Mark reserved fields as "private:" so that kernel-doc comments are
not required for them.
Add comments for @feil and @feih since @fei was split into 2 fields
because @fei is not 4-byte aligned.
These changes eliminate all kernel-doc warnings in nvme-tcp.h.
Warning: include/linux/nvme-tcp.h:95 struct member 'rsvd2' not described
in 'nvme_tcp_icreq_pdu'
Warning: include/linux/nvme-tcp.h:113 struct member 'rsvd' not described
in 'nvme_tcp_icresp_pdu'
Warning: include/linux/nvme-tcp.h:128 struct member 'feil' not described
in 'nvme_tcp_term_pdu'
Warning: include/linux/nvme-tcp.h:128 struct member 'feiu' not described
in 'nvme_tcp_term_pdu'
Warning: include/linux/nvme-tcp.h:128 struct member 'rsvd' not described
in 'nvme_tcp_term_pdu'
Warning: include/linux/nvme-tcp.h:131 struct member 'rsvd' not described
in 'nvme_tcp_term_pdu'
Warning: include/linux/nvme-tcp.h:169 struct member 'rsvd' not described
in 'nvme_tcp_r2t_pdu'
Warning: include/linux/nvme-tcp.h:187 struct member 'rsvd' not described
in 'nvme_tcp_data_pdu'
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Keith Busch <kbusch@kernel.org>
Cc: Jens Axboe <axboe@fb.com>
Cc: Christoph Hellwig <hch@lst.de>
Cc: Sagi Grimberg <sagi@grimberg.me>
Cc: linux-nvme@lists.infradead.org
include/linux/nvme-tcp.h | 8 +++++++-
1 file changed, 7 insertions(+), 1 deletion(-)
--- linux-next-20260311.orig/include/linux/nvme-tcp.h
+++ linux-next-20260311/include/linux/nvme-tcp.h
@@ -92,6 +92,7 @@ struct nvme_tcp_icreq_pdu {
__u8 hpda;
__u8 digest;
__le32 maxr2t;
+ /* private: */
__u8 rsvd2[112];
};
@@ -110,6 +111,7 @@ struct nvme_tcp_icresp_pdu {
__u8 cpda;
__u8 digest;
__le32 maxdata;
+ /* private: */
__u8 rsvd[112];
};
@@ -118,13 +120,15 @@ struct nvme_tcp_icresp_pdu {
*
* @hdr: pdu common header
* @fes: fatal error status
- * @fei: fatal error information
+ * @feil: fatal error information (low 16 bits)
+ * @feiu: fatal error information (high 16 bits)
*/
struct nvme_tcp_term_pdu {
struct nvme_tcp_hdr hdr;
__le16 fes;
__le16 feil;
__le16 feiu;
+ /* private: */
__u8 rsvd[10];
};
@@ -166,6 +170,7 @@ struct nvme_tcp_r2t_pdu {
__u16 ttag;
__le32 r2t_offset;
__le32 r2t_length;
+ /* private: */
__u8 rsvd[4];
};
@@ -184,6 +189,7 @@ struct nvme_tcp_data_pdu {
__u16 ttag;
__le32 data_offset;
__le32 data_length;
+ /* private: */
__u8 rsvd[4];
};
next reply other threads:[~2026-03-12 5:14 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-03-12 5:14 Randy Dunlap [this message]
2026-03-12 7:03 ` Christoph Hellwig
2026-03-13 4:22 ` Randy Dunlap
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=20260312051431.684352-1-rdunlap@infradead.org \
--to=rdunlap@infradead.org \
--cc=axboe@fb.com \
--cc=hch@lst.de \
--cc=kbusch@kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-nvme@lists.infradead.org \
--cc=sagi@grimberg.me \
/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
all inboxes | Powered by JetHome®