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] [day] [month] [year] [list]

Message-ID: <CAHp75Vc4DSk=-tf2oFJyd16GSSdWO1NELsCPe26BKVKUuq_Byw@mail.gmail.com>
Date: Thu, 15 Jan 2026 18:40:36 +0200
From: Andy Shevchenko <andy.shevchenko@...il.com>
To: Hamdan Khan <hamdankhan212@...il.com>
Cc: andriy.shevchenko@...el.com, andy@...nel.org, dave.hansen@...ux.intel.com, 
	gregkh@...uxfoundation.org, hansg@...nel.org, linux-kernel@...r.kernel.org, 
	linux-media@...r.kernel.org, linux-staging@...ts.linux.dev, 
	mchehab@...nel.org, sakari.ailus@...ux.intel.com, tony.luck@...el.com
Subject: Re: [PATCH v3] staging: media: atomisp: Fix typos and formatting in headers

On Thu, Jan 15, 2026 at 6:32 PM Hamdan Khan <hamdankhan212@...il.com> wrote:
>
> > Have you tried to run kernel-doc script against this file? I believe
> > it will be a difference between before and after.
>
> I just ran the kernel-doc script for both the previous and updated
> comments. The script doesn't detect kernel-doc for either of them,
> comments even with /** because they're missing the struct
> definition in the comment like:
>
> /**
>  * struct atomisp_dvs2_coef_types - Brief description
>  * @odd_real:  Real part of the odd coefficients
>  * @odd_imag:  Imaginary part of the odd coefficients
>  * ... so on
>  */
>
> Though, these can be converted to be kernel-doc compliant if you
> prefer it.

In this case it's not needed. Please, clarify in the commit message
that even if some comments look like kernel-doc, they are not.

-- 
With Best Regards,
Andy Shevchenko