slimbus: Fix struct and documentation alignment in stream.c

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 <[email protected]>

---
Changes in v2:
- Removed static const keyword from segdist_code structure declaration.

 drivers/slimbus/stream.c | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

drivers/slimbus/stream.c +0 -2

index 1d6b38657917..863ab3075d7e 100644
@@ -18,15 +18,17 @@
  *		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 {

drivers/slimbus/stream.c +1 -0

+static const struct segdist_code segdist_codes[] = {
 	{1,	1536,	0x200,	 0xdff},
 	{2,	768,	0x100,	 0xcff},
 	{4,	384,	0x080,	 0xc7f},

Signature · 1 line

2.25.1

Quoted 5 lines · Amit Vadhavana

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.

Quoted 7 lines

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'

Quoted 5 lines

Signed-off-by Amit Vadhavana <[email protected]>

---
Changes in v2:
- Removed static const keyword from segdist_code structure

declaration.

Quoted 15 lines

 drivers/slimbus/stream.c | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

drivers/slimbus/stream.c +0 -2

index 1d6b38657917..863ab3075d7e 100644
@@ -18,15 +18,17 @@
  *           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 {

drivers/slimbus/stream.c line 30

Quoted 10 lines

drivers/slimbus/stream.c +4 -1

+struct segdist_code {
      int ratem;
      int seg_interval;
      int segdist_code;
      u32 seg_offset_mask;
 
-} segdist_codes[] = {
+};
+
+/* segdist_codes - List of all possible Segment Distribution codes. */

^ isn't a '@' character missing here?

Make sure to re-build the docs and see whether it looks fine.

Thanks,
- Ricardo.

Quoted 8 lines

drivers/slimbus/stream.c +1 -1

+static const struct segdist_code segdist_codes[] = {
      {1,     1536,   0x200,   0xdff},
      {2,     768,    0x100,   0xcff},
      {4,     384,    0x080,   0xc7f},
--

2.25.1

Hi Ricardo,

I have rebuilt it again, and there are no any warnings or errors.

Thanks
Amit v

Hi Amit,

Quoted 3 lines · Amit Vadhavana

Hi Ricardo,

I have rebuilt it again, and there are no any warnings or errors.

Thanks for checking, FWIW:

Reviewed-by Ricardo B. Marliere <[email protected]>

BTW, I received this message plus another two empty ones. Please check your settings. Also, make sure not to top-post [1].

Best regards,
- Ricardo.

[1] https://en.wikipedia.org/wiki/Posting_style#Top-posting

Quoted 3 lines

Thanks
Amit v

Hi Amit,

Quoted 3 lines · Amit Vadhavana

Hi Ricardo,

I have rebuilt it again, and there are no any warnings or errors.

Thanks for checking, FWIW:

Reviewed-by Ricardo B. Marliere <[email protected]>

BTW, I received this message plus another two empty ones. Please check your settings. Also, make sure not to top-post [1].

Best regards,
- Ricardo.

[1] https://en.wikipedia.org/wiki/Posting_style#Top-posting

Quoted 3 lines

Thanks
Amit v

Hi Ricardo,

I have rebuilt it again, and there are no any warnings or errors.

Thanks
Amit v

Quoted 63 lines · Ricardo B. Marliere

Quoted 5 lines · Amit Vadhavana

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.

Quoted 7 lines

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'

Quoted 5 lines

Signed-off-by Amit Vadhavana <[email protected]>

---
Changes in v2:
- Removed static const keyword from segdist_code structure

declaration.

Quoted 15 lines

 drivers/slimbus/stream.c | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

drivers/slimbus/stream.c +0 -2

index 1d6b38657917..863ab3075d7e 100644
@@ -18,15 +18,17 @@
  *           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 {

drivers/slimbus/stream.c line 30

Quoted 10 lines

drivers/slimbus/stream.c +4 -1

+struct segdist_code {
      int ratem;
      int seg_interval;
      int segdist_code;
      u32 seg_offset_mask;
 
-} segdist_codes[] = {
+};
+
+/* segdist_codes - List of all possible Segment Distribution codes. */

^ isn't a '@' character missing here?

Make sure to re-build the docs and see whether it looks fine.

Thanks,
- Ricardo.

Quoted 8 lines

drivers/slimbus/stream.c +1 -1

+static const struct segdist_code segdist_codes[] = {
      {1,     1536,   0x200,   0xdff},
      {2,     768,    0x100,   0xcff},
      {4,     384,    0x080,   0xc7f},
--

2.25.1

Quoted 76 lines

Hi Ricardo,

I have rebuilt it again, and there are no any warnings or errors.

Thanks
Amit v

Quoted 64 lines · Ricardo B. Marliere

Quoted 4 lines · Amit Vadhavana

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.

Quoted 8 lines

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'

Quoted 5 lines

Signed-off-by Amit Vadhavana <[email protected]>

---
Changes in v2:
- Removed static const keyword from segdist_code structure

declaration.

Quoted 15 lines

 drivers/slimbus/stream.c | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

drivers/slimbus/stream.c +0 -2

index 1d6b38657917..863ab3075d7e 100644
@@ -18,15 +18,17 @@
  *           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 {

drivers/slimbus/stream.c line 30

Quoted 10 lines

drivers/slimbus/stream.c +4 -1

+struct segdist_code {
      int ratem;
      int seg_interval;
      int segdist_code;
      u32 seg_offset_mask;
 
-} segdist_codes[] = {
+};
+
+/* segdist_codes - List of all possible Segment Distribution codes. */

^ isn't a '@' character missing here?

Make sure to re-build the docs and see whether it looks fine.

Thanks,
- Ricardo.

Quoted 8 lines

drivers/slimbus/stream.c +1 -1

+static const struct segdist_code segdist_codes[] = {
      {1,     1536,   0x200,   0xdff},
      {2,     768,    0x100,   0xcff},
      {4,     384,    0x080,   0xc7f},
--

2.25.1

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.

[...]