[<prev] [next>] [thread-next>] [day] [month] [year] [list]
Message-ID: <20231001000105.26766-1-rdunlap@infradead.org>
Date: Sat, 30 Sep 2023 17:01:04 -0700
From: Randy Dunlap <rdunlap@...radead.org>
To: linux-kernel@...r.kernel.org
Cc: Randy Dunlap <rdunlap@...radead.org>, Li Yang <leoyang.li@....com>,
linuxppc-dev@...ts.ozlabs.org, linux-arm-kernel@...ts.infradead.org
Subject: [PATCH] soc: fsl: fix kernel-doc warnings and typos
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@...radead.org>
Cc: Li Yang <leoyang.li@....com>
Cc: linuxppc-dev@...ts.ozlabs.org
Cc: linux-arm-kernel@...ts.infradead.org
---
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)
{
Powered by blists - more mailing lists