| Message ID | 20240616203231.43724-1-av2082000@gmail.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | [v2] slimbus: Fix struct and documentation alignment in stream.c | expand |
On 17 Jun 24 02:02, Amit Vadhavana wrote: > 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> > --- > Changes in v2: > - Removed `static const` keyword from `segdist_code` structure declaration. > > drivers/slimbus/stream.c | 8 +++++--- > 1 file changed, 5 insertions(+), 3 deletions(-) > > diff --git a/drivers/slimbus/stream.c b/drivers/slimbus/stream.c > index 1d6b38657917..863ab3075d7e 100644 > --- a/drivers/slimbus/stream.c > +++ b/drivers/slimbus/stream.c > @@ -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 { > +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. > +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 On Mon, 17 Jun 2024 at 22:41, Ricardo B. Marliere <ricardo@marliere.net> wrote: > On 17 Jun 24 02:02, Amit Vadhavana wrote: > > 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> > > --- > > Changes in v2: > > - Removed `static const` keyword from `segdist_code` structure > declaration. > > > > drivers/slimbus/stream.c | 8 +++++--- > > 1 file changed, 5 insertions(+), 3 deletions(-) > > > > diff --git a/drivers/slimbus/stream.c b/drivers/slimbus/stream.c > > index 1d6b38657917..863ab3075d7e 100644 > > --- a/drivers/slimbus/stream.c > > +++ b/drivers/slimbus/stream.c > > @@ -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 { > > +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. > > > > > +static const struct segdist_code segdist_codes[] = { > > {1, 1536, 0x200, 0xdff}, > > {2, 768, 0x100, 0xcff}, > > {4, 384, 0x080, 0xc7f}, > > -- > > 2.25.1 > > > > >
On Wed, 19 Jun 2024 at 23:28, Amit Vadhavana <av2082000@gmail.com> wrote: > Hi Ricardo, > > I have rebuilt it again, and there are no any warnings or errors. > > Thanks > Amit v > > On Mon, 17 Jun 2024 at 22:41, Ricardo B. Marliere <ricardo@marliere.net> > wrote: > >> On 17 Jun 24 02:02, Amit Vadhavana wrote: >> > 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> >> > --- >> > Changes in v2: >> > - Removed `static const` keyword from `segdist_code` structure >> declaration. >> > >> > drivers/slimbus/stream.c | 8 +++++--- >> > 1 file changed, 5 insertions(+), 3 deletions(-) >> > >> > diff --git a/drivers/slimbus/stream.c b/drivers/slimbus/stream.c >> > index 1d6b38657917..863ab3075d7e 100644 >> > --- a/drivers/slimbus/stream.c >> > +++ b/drivers/slimbus/stream.c >> > @@ -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 { >> > +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. >> >> >> >> > +static const struct segdist_code segdist_codes[] = { >> > {1, 1536, 0x200, 0xdff}, >> > {2, 768, 0x100, 0xcff}, >> > {4, 384, 0x080, 0xc7f}, >> > -- >> > 2.25.1 >> > >> > >> >
> > > On Wed, 19 Jun 2024 at 23:28, Amit Vadhavana <av2082000@gmail.com> wrote: > >> Hi Ricardo, >> >> I have rebuilt it again, and there are no any warnings or errors. >> >> Thanks >> Amit v >> >> On Mon, 17 Jun 2024 at 22:41, Ricardo B. Marliere <ricardo@marliere.net> >> wrote: >> >>> On 17 Jun 24 02:02, Amit Vadhavana wrote: >>> > 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> >>> > --- >>> > Changes in v2: >>> > - Removed `static const` keyword from `segdist_code` structure >>> declaration. >>> > >>> > drivers/slimbus/stream.c | 8 +++++--- >>> > 1 file changed, 5 insertions(+), 3 deletions(-) >>> > >>> > diff --git a/drivers/slimbus/stream.c b/drivers/slimbus/stream.c >>> > index 1d6b38657917..863ab3075d7e 100644 >>> > --- a/drivers/slimbus/stream.c >>> > +++ b/drivers/slimbus/stream.c >>> > @@ -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 { >>> > +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. >>> >>> >>> >>> > +static const struct segdist_code segdist_codes[] = { >>> > {1, 1536, 0x200, 0xdff}, >>> > {2, 768, 0x100, 0xcff}, >>> > {4, 384, 0x080, 0xc7f}, >>> > -- >>> > 2.25.1 >>> > >>> > >>> >>
Hi Amit, On 19 Jun 24 23:28, Amit Vadhavana wrote: > Hi Ricardo, > > I have rebuilt it again, and there are no any warnings or errors. Thanks for checking, FWIW: Reviewed-by: Ricardo B. Marliere <ricardo@marliere.net> 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 > > Thanks > Amit v
Hi Srinivas, I hope you are well. I am following up on a patch I submitted on 19 Jun regarding a kernel document and Ricardo reviewed the patch. I understand you have a busy schedule, but if you could find some time to review the patch, I would greatly appreciate it. Your feedback would be invaluable in helping to improve the quality of this contribution. If there are any changes needed or additional steps I should take, please let me know. Thanks Amit V On Thu, 20 Jun 2024 at 18:00, Ricardo B. Marliere <ricardo@marliere.net> wrote: > Hi Amit, > > On 19 Jun 24 23:28, Amit Vadhavana wrote: > > Hi Ricardo, > > > > I have rebuilt it again, and there are no any warnings or errors. > > Thanks for checking, FWIW: > > Reviewed-by: Ricardo B. Marliere <ricardo@marliere.net> > > 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 > > > > > > > Thanks > > Amit v >
On Thu, 20 Jun 2024 at 18:00, Ricardo B. Marliere <ricardo@marliere.net> wrote: > > Hi Amit, > > On 19 Jun 24 23:28, Amit Vadhavana wrote: > > Hi Ricardo, > > > > I have rebuilt it again, and there are no any warnings or errors. > > Thanks for checking, FWIW: > > Reviewed-by: Ricardo B. Marliere <ricardo@marliere.net> > > 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 > > > > > > > Thanks > > Amit v Hi Srinivas, I hope you are well. I am following up on a patch I submitted on 19 Jun regarding a kernel document and Ricardo reviewed the patch. I understand you have a busy schedule, but if you could find some time to review the patch, I would greatly appreciate it. Your feedback would be invaluable in helping to improve the quality of this contribution. If there are any changes needed or additional steps I should take, please let me know. Thanks Amit V
On Mon, 17 Jun 2024 02:02:31 +0530, Amit Vadhavana wrote: > 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. > > [...] Applied, thanks! [1/1] slimbus: Fix struct and documentation alignment in stream.c commit: cea500f1ad5f6e93e67ab6f9a317d713524732cd Best regards,
diff --git a/drivers/slimbus/stream.c b/drivers/slimbus/stream.c index 1d6b38657917..863ab3075d7e 100644 --- a/drivers/slimbus/stream.c +++ b/drivers/slimbus/stream.c @@ -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 { +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. */ +static const struct segdist_code segdist_codes[] = { {1, 1536, 0x200, 0xdff}, {2, 768, 0x100, 0xcff}, {4, 384, 0x080, 0xc7f},
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> --- Changes in v2: - Removed `static const` keyword from `segdist_code` structure declaration. drivers/slimbus/stream.c | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-)