2024-05-24 17:01:59

by Abhishek Tamboli

[permalink] [raw]
Subject: [PATCH] Correct documentation for struct segdist_code

Correct the documentation for struct segdist_code by
removing the incorrect reference to segdist_codes and
add a note to describe the array.

Reported-by: kernel test robot <[email protected]>
Closes: https://lore.kernel.org/oe-kbuild-all/[email protected]/

Signed-off-by: Abhishek Tamboli <[email protected]>
---
The documentation for struct segdist_code contained an incorrect reference
to segdist_codes as a member. This patch removes that incorrect reference
and adds a note to describe the array segdist_codes[] containing all possible
Segment Distribution codes.

drivers/slimbus/stream.c | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/drivers/slimbus/stream.c b/drivers/slimbus/stream.c
index 1d6b38657917..d9eaa8989d2e 100644
--- a/drivers/slimbus/stream.c
+++ b/drivers/slimbus/stream.c
@@ -18,7 +18,8 @@
* and the first slot of the next consecutive Segment.
* @segdist_code: Segment Distribution Code SD[11:0]
* @seg_offset_mask: Segment offset mask in SD[11:0]
- * @segdist_codes: List of all possible Segmet Distribution codes.
+ *
+ * Note: segdist_codes: List of all possible Segmet Distribution codes.
*/
static const struct segdist_code {
int ratem;

base-commit: f3d61438b613b87afb63118bea6fb18c50ba7a6b
prerequisite-patch-id: f30868a7fdcfaceb6bab2b6f41402a9aeae858cb
--
2.25.1