From: Amit Vadhavana <av2082000@gmail.com>
To: srinivas.kandagatla@linaro.org, alsa-devel@alsa-project.org,
linux-kernel@vger.kernel.org, rbmarliere@gmail.com,
skhan@linuxfoundation.org
Cc: linux-kernel-mentees@lists.linuxfoundation.org, av2082000@gmail.com
Subject: [PATCH] slimbus: Fix struct and documentation alignment in stream.c
Date: Sun, 16 Jun 2024 21:15:31 +0530 [thread overview]
Message-ID: <20240616154531.38232-1-av2082000@gmail.com> (raw)
The placement of the `segdist_codes` array documentation was corrected
to conform with kernel documentation guidelines. The `@segdist_codes`
was placed incorrectly within the struct `segdist_code` documentation
block, which led to a potential misinterpretation of the code structure.
The `segdist_codes` array documentation was moved outside the struct
block, and a separate comment block was provided for it. This change
ensures that clarity and proper alignment with kernel documentation
standards are maintained.
A kernel-doc warning was addressed:
./drivers/slimbus/stream.c:49: warning: Excess struct member 'segdist_codes' description in 'segdist_code'
Signed-off-by: Amit Vadhavana <av2082000@gmail.com>
---
drivers/slimbus/stream.c | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/drivers/slimbus/stream.c b/drivers/slimbus/stream.c
index 1d6b38657917..62661211a409 100644
--- a/drivers/slimbus/stream.c
+++ b/drivers/slimbus/stream.c
@@ -18,7 +18,6 @@
* 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.
*/
static const struct segdist_code {
int ratem;
@@ -26,7 +25,10 @@ static const struct segdist_code {
int segdist_code;
u32 seg_offset_mask;
-} segdist_codes[] = {
+};
+
+/* segdist_codes - List of all possible Segment Distribution codes. */
+static const struct segdist_code segdist_codes[] = {
{1, 1536, 0x200, 0xdff},
{2, 768, 0x100, 0xcff},
{4, 384, 0x080, 0xc7f},
--
2.25.1
next reply other threads:[~2024-06-18 11:26 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-06-16 15:45 Amit Vadhavana [this message]
2024-06-16 18:45 ` [PATCH] slimbus: Fix struct and documentation alignment in stream.c kernel test robot
2024-06-16 19:07 ` kernel test robot
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=20240616154531.38232-1-av2082000@gmail.com \
--to=av2082000@gmail.com \
--cc=alsa-devel@alsa-project.org \
--cc=linux-kernel-mentees@lists.linuxfoundation.org \
--cc=linux-kernel@vger.kernel.org \
--cc=rbmarliere@gmail.com \
--cc=skhan@linuxfoundation.org \
--cc=srinivas.kandagatla@linaro.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