From: Hans Verkuil <hverkuil-cisco@xs4all.nl>
To: Ricardo Ribalda <ribalda@chromium.org>,
Jonathan Corbet <corbet@lwn.net>,
Randy Dunlap <rdunlap@infradead.org>
Cc: Tiffany Lin <tiffany.lin@mediatek.com>,
Andrew-CT Chen <andrew-ct.chen@mediatek.com>,
Yunfei Dong <yunfei.dong@mediatek.com>,
Mauro Carvalho Chehab <mchehab@kernel.org>,
Matthias Brugger <matthias.bgg@gmail.com>,
AngeloGioacchino Del Regno
<angelogioacchino.delregno@collabora.com>,
Sakari Ailus <sakari.ailus@linux.intel.com>,
Laurent Pinchart <laurent.pinchart@ideasonboard.com>,
Hans Verkuil <hverkuil@xs4all.nl>,
Kieran Bingham <kieran.bingham@ideasonboard.com>,
Bin Liu <bin.liu@mediatek.com>,
Ezequiel Garcia <ezequiel@vanguardiasur.com.ar>,
Philipp Zabel <p.zabel@pengutronix.de>,
Stanimir Varbanov <stanimir.k.varbanov@gmail.com>,
Vikash Garodia <quic_vgarodia@quicinc.com>,
Bryan O'Donoghue <bryan.odonoghue@linaro.org>,
Bjorn Andersson <andersson@kernel.org>,
Konrad Dybcio <konrad.dybcio@linaro.org>,
Sylwester Nawrocki <s.nawrocki@samsung.com>,
Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>,
Alim Akhtar <alim.akhtar@samsung.com>,
Marek Szyprowski <m.szyprowski@samsung.com>,
Andrzej Hajda <andrzej.hajda@intel.com>,
Bingbu Cao <bingbu.cao@intel.com>,
Tianshu Qiu <tian.shu.qiu@intel.com>,
Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
Neil Armstrong <neil.armstrong@linaro.org>,
Kevin Hilman <khilman@baylibre.com>,
Jerome Brunet <jbrunet@baylibre.com>,
Martin Blumenstingl <martin.blumenstingl@googlemail.com>,
linux-media@vger.kernel.org, linux-kernel@vger.kernel.org,
linux-arm-kernel@lists.infradead.org,
linux-mediatek@lists.infradead.org,
linux-rockchip@lists.infradead.org,
linux-arm-msm@vger.kernel.org, linux-samsung-soc@vger.kernel.org,
linux-staging@lists.linux.dev, linux-amlogic@lists.infradead.org,
Sakari Ailus <sakari.ailus@iki.fi>
Subject: Re: [PATCH 17/17] linux: v4l2-vp9.h: Fix kerneldoc
Date: Mon, 5 Feb 2024 11:29:01 +0100 [thread overview]
Message-ID: <201ae1d1-1e03-40e2-9cc4-49df70abb8da@xs4all.nl> (raw)
In-Reply-To: <ZbTTb-SdK-EubGdc@valkosipuli.retiisi.eu>
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
next prev parent reply other threads:[~2024-02-05 10:29 UTC|newest]
Thread overview: 48+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-01-26 23:15 [PATCH 00/17] media: kerneldoc warnings Ricardo Ribalda
2024-01-26 23:16 ` [PATCH 01/17] media: mediatek: vcodec: Fix " Ricardo Ribalda
2024-01-27 1:38 ` Randy Dunlap
2024-01-29 10:08 ` AngeloGioacchino Del Regno
2024-01-26 23:16 ` [PATCH 02/17] media: videodev2.h: Fix kerneldoc Ricardo Ribalda
2024-01-27 1:42 ` Randy Dunlap
2024-01-29 10:08 ` AngeloGioacchino Del Regno
2024-01-26 23:16 ` [PATCH 03/17] media: media-entity.h: " Ricardo Ribalda
2024-01-27 1:51 ` Randy Dunlap
2024-01-27 18:40 ` Sakari Ailus
2024-01-27 20:50 ` Randy Dunlap
2024-01-27 9:48 ` Sakari Ailus
2024-01-26 23:16 ` [PATCH 04/17] media: cec.h: " Ricardo Ribalda
2024-01-27 21:02 ` Randy Dunlap
2024-01-26 23:16 ` [PATCH 05/17] media: pci: dt315.h: " Ricardo Ribalda
2024-01-27 21:03 ` Randy Dunlap
2024-01-26 23:16 ` [PATCH 06/17] media: i2c: css-quirk.h: " Ricardo Ribalda
2024-01-27 22:00 ` Randy Dunlap
2024-01-26 23:16 ` [PATCH 07/17] media: i2c: adv748: " Ricardo Ribalda
2024-01-27 22:02 ` Randy Dunlap
2024-01-28 11:01 ` Kieran Bingham
2024-01-26 23:16 ` [PATCH 08/17] media: mediatek: jpeg: " Ricardo Ribalda
2024-01-27 22:03 ` Randy Dunlap
2024-01-29 10:08 ` AngeloGioacchino Del Regno
2024-01-26 23:16 ` [PATCH 09/17] media: mediatek: vcodec: " Ricardo Ribalda
2024-01-27 22:07 ` Randy Dunlap
2024-01-29 10:08 ` AngeloGioacchino Del Regno
2024-01-26 23:16 ` [PATCH 10/17] media: verisilicon: " Ricardo Ribalda
2024-01-27 22:09 ` Randy Dunlap
2024-01-26 23:16 ` [PATCH 11/17] media: qcom: venus: " Ricardo Ribalda
2024-01-27 22:13 ` Randy Dunlap
2024-01-27 22:14 ` Randy Dunlap
2024-01-26 23:16 ` [PATCH 12/17] media: samsung: exynos4-is: " Ricardo Ribalda
2024-01-27 22:16 ` Randy Dunlap
2024-01-26 23:16 ` [PATCH 13/17] media: samsung: s5p-mfc: " Ricardo Ribalda
2024-01-27 22:17 ` Randy Dunlap
2024-01-26 23:16 ` [PATCH 14/17] media: dvb-usb: " Ricardo Ribalda
2024-01-27 22:19 ` Randy Dunlap
2024-01-26 23:16 ` [PATCH 15/17] media: ipu3: " Ricardo Ribalda
2024-01-27 22:22 ` Randy Dunlap
2024-01-26 23:16 ` [PATCH 16/17] media: staging: meson: " Ricardo Ribalda
2024-01-27 22:23 ` Randy Dunlap
2024-01-26 23:16 ` [PATCH 17/17] linux: v4l2-vp9.h: " Ricardo Ribalda
2024-01-27 9:57 ` Sakari Ailus
2024-02-05 10:29 ` Hans Verkuil [this message]
2024-02-05 10:39 ` Randy Dunlap
2024-02-05 10:44 ` Hans Verkuil
2024-02-05 10:53 ` Sakari Ailus
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=201ae1d1-1e03-40e2-9cc4-49df70abb8da@xs4all.nl \
--to=hverkuil-cisco@xs4all.nl \
--cc=alim.akhtar@samsung.com \
--cc=andersson@kernel.org \
--cc=andrew-ct.chen@mediatek.com \
--cc=andrzej.hajda@intel.com \
--cc=angelogioacchino.delregno@collabora.com \
--cc=bin.liu@mediatek.com \
--cc=bingbu.cao@intel.com \
--cc=bryan.odonoghue@linaro.org \
--cc=corbet@lwn.net \
--cc=ezequiel@vanguardiasur.com.ar \
--cc=gregkh@linuxfoundation.org \
--cc=hverkuil@xs4all.nl \
--cc=jbrunet@baylibre.com \
--cc=khilman@baylibre.com \
--cc=kieran.bingham@ideasonboard.com \
--cc=konrad.dybcio@linaro.org \
--cc=krzysztof.kozlowski@linaro.org \
--cc=laurent.pinchart@ideasonboard.com \
--cc=linux-amlogic@lists.infradead.org \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-arm-msm@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-media@vger.kernel.org \
--cc=linux-mediatek@lists.infradead.org \
--cc=linux-rockchip@lists.infradead.org \
--cc=linux-samsung-soc@vger.kernel.org \
--cc=linux-staging@lists.linux.dev \
--cc=m.szyprowski@samsung.com \
--cc=martin.blumenstingl@googlemail.com \
--cc=matthias.bgg@gmail.com \
--cc=mchehab@kernel.org \
--cc=neil.armstrong@linaro.org \
--cc=p.zabel@pengutronix.de \
--cc=quic_vgarodia@quicinc.com \
--cc=rdunlap@infradead.org \
--cc=ribalda@chromium.org \
--cc=s.nawrocki@samsung.com \
--cc=sakari.ailus@iki.fi \
--cc=sakari.ailus@linux.intel.com \
--cc=stanimir.k.varbanov@gmail.com \
--cc=tian.shu.qiu@intel.com \
--cc=tiffany.lin@mediatek.com \
--cc=yunfei.dong@mediatek.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox