| 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
| ||
|
Date: Fri, 26 Jan 2024 17:42:32 -0800
From: Randy Dunlap <rdunlap@...radead.org>
To: Ricardo Ribalda <ribalda@...omium.org>,
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-cisco@...all.nl>, 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>
Cc: 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
Subject: Re: [PATCH 02/17] media: videodev2.h: Fix kerneldoc
On 1/26/24 15:16, Ricardo Ribalda wrote:
> 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@...omium.org>
Reviewed-by: Randy Dunlap <rdunlap@...radead.org>
Tested-by: Randy Dunlap <rdunlap@...radead.org>
Thanks.
> ---
> 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;
>
--
#Randy
Powered by blists - more mailing lists