From: Ricardo Ribalda <ribalda@chromium.org>
To: 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-cisco@xs4all.nl>,
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>
Cc: 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,
Ricardo Ribalda <ribalda@chromium.org>
Subject: [PATCH 02/17] media: videodev2.h: Fix kerneldoc
Date: Fri, 26 Jan 2024 23:16:01 +0000 [thread overview]
Message-ID: <20240126-gix-mtk-warnings-v1-2-eed7865fce18@chromium.org> (raw)
In-Reply-To: <20240126-gix-mtk-warnings-v1-0-eed7865fce18@chromium.org>
Named nested unions need their prefix:
https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html#nested-structs-unions
Signed-off-by: Ricardo Ribalda <ribalda@chromium.org>
---
include/uapi/linux/videodev2.h | 32 ++++++++++++++++----------------
1 file changed, 16 insertions(+), 16 deletions(-)
diff --git a/include/uapi/linux/videodev2.h b/include/uapi/linux/videodev2.h
index 68e7ac178cc2..a8015e5e7fa4 100644
--- a/include/uapi/linux/videodev2.h
+++ b/include/uapi/linux/videodev2.h
@@ -1041,13 +1041,13 @@ struct v4l2_requestbuffers {
* struct v4l2_plane - plane info for multi-planar buffers
* @bytesused: number of bytes occupied by data in the plane (payload)
* @length: size of this plane (NOT the payload) in bytes
- * @mem_offset: when memory in the associated struct v4l2_buffer is
+ * @m.mem_offset: when memory in the associated struct v4l2_buffer is
* V4L2_MEMORY_MMAP, equals the offset from the start of
* the device memory for this plane (or is a "cookie" that
* should be passed to mmap() called on the video node)
- * @userptr: when memory is V4L2_MEMORY_USERPTR, a userspace pointer
+ * @m.userptr: when memory is V4L2_MEMORY_USERPTR, a userspace pointer
* pointing to this plane
- * @fd: when memory is V4L2_MEMORY_DMABUF, a userspace file
+ * @m.fd: when memory is V4L2_MEMORY_DMABUF, a userspace file
* descriptor associated with this plane
* @m: union of @mem_offset, @userptr and @fd
* @data_offset: offset in the plane to the start of data; usually 0,
@@ -1085,14 +1085,14 @@ struct v4l2_plane {
* @sequence: sequence count of this frame
* @memory: enum v4l2_memory; the method, in which the actual video data is
* passed
- * @offset: for non-multiplanar buffers with memory == V4L2_MEMORY_MMAP;
+ * @m.offset: for non-multiplanar buffers with memory == V4L2_MEMORY_MMAP;
* offset from the start of the device memory for this plane,
* (or a "cookie" that should be passed to mmap() as offset)
- * @userptr: for non-multiplanar buffers with memory == V4L2_MEMORY_USERPTR;
+ * @m.userptr: for non-multiplanar buffers with memory == V4L2_MEMORY_USERPTR;
* a userspace pointer pointing to this buffer
- * @fd: for non-multiplanar buffers with memory == V4L2_MEMORY_DMABUF;
+ * @m.fd: for non-multiplanar buffers with memory == V4L2_MEMORY_DMABUF;
* a userspace file descriptor associated with this buffer
- * @planes: for multiplanar buffers; userspace pointer to the array of plane
+ * @m.planes: for multiplanar buffers; userspace pointer to the array of plane
* info structs for this buffer
* @m: union of @offset, @userptr, @planes and @fd
* @length: size in bytes of the buffer (NOT its payload) for single-plane
@@ -2423,15 +2423,15 @@ struct v4l2_meta_format {
/**
* struct v4l2_format - stream data format
- * @type: enum v4l2_buf_type; type of the data stream
- * @pix: definition of an image format
- * @pix_mp: definition of a multiplanar image format
- * @win: definition of an overlaid image
- * @vbi: raw VBI capture or output parameters
- * @sliced: sliced VBI capture or output parameters
- * @raw_data: placeholder for future extensions and custom formats
- * @fmt: union of @pix, @pix_mp, @win, @vbi, @sliced, @sdr, @meta
- * and @raw_data
+ * @type: enum v4l2_buf_type; type of the data stream
+ * @fmt.pix: definition of an image format
+ * @fmt.pix_mp: definition of a multiplanar image format
+ * @fmt.win: definition of an overlaid image
+ * @fmt.vbi: raw VBI capture or output parameters
+ * @fmt.sliced: sliced VBI capture or output parameters
+ * @fmt.raw_data: placeholder for future extensions and custom formats
+ * @fmt: union of @pix, @pix_mp, @win, @vbi, @sliced, @sdr,
+ * @meta and @raw_data
*/
struct v4l2_format {
__u32 type;
--
2.43.0.429.g432eaa2c6b-goog
next prev parent reply other threads:[~2024-01-26 23:16 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 ` Ricardo Ribalda [this message]
2024-01-27 1:42 ` [PATCH 02/17] media: videodev2.h: Fix kerneldoc 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
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=20240126-gix-mtk-warnings-v1-2-eed7865fce18@chromium.org \
--to=ribalda@chromium.org \
--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=ezequiel@vanguardiasur.com.ar \
--cc=gregkh@linuxfoundation.org \
--cc=hverkuil-cisco@xs4all.nl \
--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=s.nawrocki@samsung.com \
--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;
as well as URLs for NNTP newsgroup(s).