linux-kernel - Re: [PATCH 17/17] linux: v4l2-vp9.h: Fix kerneldoc

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: <201ae1d1-1e03-40e2-9cc4-49df70abb8da@xs4all.nl>
Date: Mon, 5 Feb 2024 11:29:01 +0100
From: Hans Verkuil <hverkuil-cisco@...all.nl>
To: Ricardo Ribalda <ribalda@...omium.org>, Jonathan Corbet <corbet@....net>,
 Randy Dunlap <rdunlap@...radead.org>
Cc: Tiffany Lin <tiffany.lin@...iatek.com>,
 Andrew-CT Chen <andrew-ct.chen@...iatek.com>,
 Yunfei Dong <yunfei.dong@...iatek.com>,
 Mauro Carvalho Chehab <mchehab@...nel.org>,
 Matthias Brugger <matthias.bgg@...il.com>,
 AngeloGioacchino Del Regno <angelogioacchino.delregno@...labora.com>,
 Sakari Ailus <sakari.ailus@...ux.intel.com>,
 Laurent Pinchart <laurent.pinchart@...asonboard.com>,
 Hans Verkuil <hverkuil@...all.nl>,
 Kieran Bingham <kieran.bingham@...asonboard.com>,
 Bin Liu <bin.liu@...iatek.com>,
 Ezequiel Garcia <ezequiel@...guardiasur.com.ar>,
 Philipp Zabel <p.zabel@...gutronix.de>,
 Stanimir Varbanov <stanimir.k.varbanov@...il.com>,
 Vikash Garodia <quic_vgarodia@...cinc.com>,
 Bryan O'Donoghue <bryan.odonoghue@...aro.org>,
 Bjorn Andersson <andersson@...nel.org>,
 Konrad Dybcio <konrad.dybcio@...aro.org>,
 Sylwester Nawrocki <s.nawrocki@...sung.com>,
 Krzysztof Kozlowski <krzysztof.kozlowski@...aro.org>,
 Alim Akhtar <alim.akhtar@...sung.com>,
 Marek Szyprowski <m.szyprowski@...sung.com>,
 Andrzej Hajda <andrzej.hajda@...el.com>, Bingbu Cao <bingbu.cao@...el.com>,
 Tianshu Qiu <tian.shu.qiu@...el.com>,
 Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
 Neil Armstrong <neil.armstrong@...aro.org>,
 Kevin Hilman <khilman@...libre.com>, Jerome Brunet <jbrunet@...libre.com>,
 Martin Blumenstingl <martin.blumenstingl@...glemail.com>,
 linux-media@...r.kernel.org, linux-kernel@...r.kernel.org,
 linux-arm-kernel@...ts.infradead.org, linux-mediatek@...ts.infradead.org,
 linux-rockchip@...ts.infradead.org, linux-arm-msm@...r.kernel.org,
 linux-samsung-soc@...r.kernel.org, linux-staging@...ts.linux.dev,
 linux-amlogic@...ts.infradead.org, Sakari Ailus <sakari.ailus@....fi>
Subject: Re: [PATCH 17/17] linux: v4l2-vp9.h: Fix kerneldoc

On 27/01/2024 10:57, Sakari Ailus wrote:
> Hi Ricardo,
> 
> On Fri, Jan 26, 2024 at 11:16:16PM +0000, Ricardo Ribalda wrote:
>> Kerneldoc cannot understand arrays defined like
>> v4l2_frame_symbol_counts.
>>
>> Adding an asterisk to the name does do the trick.
>>
>> Disable the kerneldoc notation for now, it is already ignored:
>> https://docs.kernel.org/search.html?q=v4l2_vp9_frame_symbol_counts
> 
> Wouldn't it be nicer to fix kerneldoc instead? It might not be difficult at
> all.
> 
> Feel free to, but I can also give it a try.
> 

It would be nice to have this fixed in kerneldoc itself. I'm holding this
patch back for two weeks to see if someone wants to work on kerneldoc.

If not, then I'll take this anyway to fix the noise in our build.

Note that while this header is indeed ignored in the documentation, that
is really more a bug and it would be nice to actually include this header
somewhere in our documentation. So fixing these kerneldoc warnings one way
or another is something that we should do.

Regards,

	Hans