linux-kernel - Re: [PATCH v2] slimbus: Fix struct and documentation alignment in stream.c

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <d6cd7441-53f2-4c88-a361-729e3abe81c1@marliere.net>
Date: Mon, 17 Jun 2024 14:11:48 -0300
From: "Ricardo B. Marliere" <ricardo@...liere.net>
To: Amit Vadhavana <av2082000@...il.com>
Cc: srinivas.kandagatla@...aro.org, alsa-devel@...a-project.org,
	linux-kernel@...r.kernel.org, rbmarliere@...il.com,
	skhan@...uxfoundation.org,
	linux-kernel-mentees@...ts.linuxfoundation.org
Subject: Re: [PATCH v2] slimbus: Fix struct and documentation alignment in
 stream.c

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 `@...dist_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@...il.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
> 
>