linux-kernel - Re: [PATCH v3] staging: media: atomisp: Fix typos and formatting in headers

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: <aWjiwto4BQS8Uudz@smile.fi.intel.com>
Date: Thu, 15 Jan 2026 14:51:14 +0200
From: Andy Shevchenko <andriy.shevchenko@...el.com>
To: Hamdan Khan <hamdankhan212@...il.com>
Cc: gregkh@...uxfoundation.org, andy@...nel.org, hansg@...nel.org,
	mchehab@...nel.org, sakari.ailus@...ux.intel.com,
	dave.hansen@...ux.intel.com, tony.luck@...el.com,
	linux-media@...r.kernel.org, linux-staging@...ts.linux.dev,
	linux-kernel@...r.kernel.org
Subject: Re: [PATCH v3] staging: media: atomisp: Fix typos and formatting in
 headers

On Thu, Jan 15, 2026 at 05:11:57PM +0500, Hamdan Khan wrote:
> This patch updates block and inline comments to follow kernel
> commenting conventions, fixes typos and wording, and reformats
> long comments for clarity and line length consistency.
> 
> No functional changes are intended.

...

> -/* DVS 2.0 Coefficient types. This structure contains 4 pointers to
> - *  arrays that contain the coefficients for each type.
> +/*
> + * DVS 2.0 Coefficient types. This structure contains 4 pointers to
> + * arrays that contain the coefficients for each type.
>   */
>  struct atomisp_dvs2_coef_types {
> -	short __user *odd_real; /** real part of the odd coefficients*/
> -	short __user *odd_imag; /** imaginary part of the odd coefficients*/
> -	short __user *even_real;/** real part of the even coefficients*/
> -	short __user *even_imag;/** imaginary part of the even coefficients*/
> +	short __user *odd_real; /* Real part of the odd coefficients*/
> +	short __user *odd_imag; /* Imaginary part of the odd coefficients*/
> +	short __user *even_real;/* Real part of the even coefficients*/
> +	short __user *even_imag;/* Imaginary part of the even coefficients*/
>  };

Have you tried to run kernel-doc script against this file? I believe
it will be a difference between before and after.

If so, it means that it's better to convert the description to be a fully
kernel-doc compliant.

...

>  struct atomisp_dvs2_stat_types {
> -	int __user *odd_real; /** real part of the odd statistics*/
> -	int __user *odd_imag; /** imaginary part of the odd statistics*/
> -	int __user *even_real;/** real part of the even statistics*/
> -	int __user *even_imag;/** imaginary part of the even statistics*/
> +	int __user *odd_real; /* Real part of the odd statistics*/
> +	int __user *odd_imag; /* Imaginary part of the odd statistics*/
> +	int __user *even_real;/* Real part of the even statistics*/
> +	int __user *even_imag;/* Imaginary part of the even statistics*/
>  };

Ditto.

...

>  struct atomisp_resolution {
> -	u32 width;  /** Width */
> -	u32 height; /** Height */
> +	u32 width;  /* Width */
> +	u32 height; /* Height */
>  };

Ditto and so on...

(As for this data type I think it makes sense to research for a substitution
 from the existing ones or even cease the existence of atomisp_resolution.)

-- 
With Best Regards,
Andy Shevchenko