From: Randy Dunlap <rdunlap@infradead.org>
To: linux-kernel@vger.kernel.org
Cc: Roy Pledge <Roy.Pledge@nxp.com>,
Randy Dunlap <rdunlap@infradead.org>, Frank Li <Frank.Li@nxp.com>,
Li Yang <leoyang.li@nxp.com>, Guanhua Gao <guanhua.gao@nxp.com>,
linuxppc-dev@lists.ozlabs.org,
linux-arm-kernel@lists.infradead.org
Subject: [PATCH v2] soc: fsl: fix kernel-doc warnings and typos
Date: Sun, 4 Feb 2024 21:53:49 -0800 [thread overview]
Message-ID: <20240205055349.24410-1-rdunlap@infradead.org> (raw)
Correct spelling of "list".
Fix a kernel-doc warning by describing the nested structure completely:
include/soc/fsl/dpaa2-fd.h:52: warning: Function parameter or member 'simple' not described in 'dpaa2_fd'
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Li Yang <leoyang.li@nxp.com>
Cc: linuxppc-dev@lists.ozlabs.org
Cc: linux-arm-kernel@lists.infradead.org
Cc: Frank Li <Frank.Li@nxp.com>
Cc: Guanhua Gao <guanhua.gao@nxp.com>
Cc: Roy Pledge <Roy.Pledge@nxp.com>
---
v2: update Cc: list, rebase
include/soc/fsl/dpaa2-fd.h | 19 ++++++++++---------
1 file changed, 10 insertions(+), 9 deletions(-)
diff -- a/include/soc/fsl/dpaa2-fd.h b/include/soc/fsl/dpaa2-fd.h
--- a/include/soc/fsl/dpaa2-fd.h
+++ b/include/soc/fsl/dpaa2-fd.h
@@ -25,14 +25,15 @@
/**
* struct dpaa2_fd - Struct describing FDs
- * @words: for easier/faster copying the whole FD structure
- * @addr: address in the FD
- * @len: length in the FD
- * @bpid: buffer pool ID
- * @format_offset: format, offset, and short-length fields
- * @frc: frame context
- * @ctrl: control bits...including dd, sc, va, err, etc
- * @flc: flow context address
+ * @words: for easier/faster copying the whole FD structure
+ * @simple: struct for the FD fields
+ * @simple.addr: address in the FD
+ * @simple.len: length in the FD
+ * @simple.bpid: buffer pool ID
+ * @simple.format_offset: format, offset, and short-length fields
+ * @simple.frc: frame context
+ * @simple.ctrl: control bits...including dd, sc, va, err, etc
+ * @simple.flc: flow context address
*
* This structure represents the basic Frame Descriptor used in the system.
*/
@@ -497,7 +498,7 @@ static inline void dpaa2_fl_set_addr(str
* dpaa2_fl_get_frc() - Get the frame context in the FLE
* @fle: the given frame list entry
*
- * Return the frame context field in the frame lsit entry.
+ * Return the frame context field in the frame list entry.
*/
static inline u32 dpaa2_fl_get_frc(const struct dpaa2_fl_entry *fle)
{
reply other threads:[~2024-02-05 5:55 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
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=20240205055349.24410-1-rdunlap@infradead.org \
--to=rdunlap@infradead.org \
--cc=Frank.Li@nxp.com \
--cc=Roy.Pledge@nxp.com \
--cc=guanhua.gao@nxp.com \
--cc=leoyang.li@nxp.com \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linuxppc-dev@lists.ozlabs.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).