| Message ID | 20240126-gix-mtk-warnings-v1-2-eed7865fce18@chromium.org (mailing list archive) |
|---|---|
| State | New |
| Headers | show |
| Series | media: kerneldoc warnings | expand |
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@chromium.org> Reviewed-by: Randy Dunlap <rdunlap@infradead.org> Tested-by: Randy Dunlap <rdunlap@infradead.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; >
Il 27/01/24 00:16, Ricardo Ribalda ha scritto: > 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> Reviewed-by: AngeloGioacchino Del Regno <angelogioacchino.delregno@collabora.com>
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;
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(-)