| Message ID | 20240105125437.30926-1-andrzej.p@collabora.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | media: videobuf2: Fix doc comment | expand |
On Fri, Jan 5, 2024 at 9:54 PM Andrzej Pietrasiewicz <andrzej.p@collabora.com> wrote: > > The documented struct member is called "planes" rather than "vb2_plane". > While at it, make the comments order follow struct members order. > > Fixes: 2b1413245550 ("media: vb2-core: Improve kernel-doc markups") > Signed-off-by: Andrzej Pietrasiewicz <andrzej.p@collabora.com> > --- > include/media/videobuf2-core.h | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/include/media/videobuf2-core.h b/include/media/videobuf2-core.h > index 4b6a9d2ea372..e41204df19f0 100644 > --- a/include/media/videobuf2-core.h > +++ b/include/media/videobuf2-core.h > @@ -271,11 +271,11 @@ struct vb2_buffer { > * skips cache sync/invalidation. > * skip_cache_sync_on_finish: when set buffer's ->finish() function > * skips cache sync/invalidation. > + * planes: per-plane information; do not change > * queued_entry: entry on the queued buffers list, which holds > * all buffers queued from userspace > * done_entry: entry on the list that stores all buffers ready > * to be dequeued to userspace > - * vb2_plane: per-plane information; do not change > */ > enum vb2_buffer_state state; > unsigned int synced:1; > -- > 2.25.1 > Acked-by: Tomasz Figa <tfiga@chromium.org> Thanks for the doc improvement. Best regards, Tomasz
diff --git a/include/media/videobuf2-core.h b/include/media/videobuf2-core.h index 4b6a9d2ea372..e41204df19f0 100644 --- a/include/media/videobuf2-core.h +++ b/include/media/videobuf2-core.h @@ -271,11 +271,11 @@ struct vb2_buffer { * skips cache sync/invalidation. * skip_cache_sync_on_finish: when set buffer's ->finish() function * skips cache sync/invalidation. + * planes: per-plane information; do not change * queued_entry: entry on the queued buffers list, which holds * all buffers queued from userspace * done_entry: entry on the list that stores all buffers ready * to be dequeued to userspace - * vb2_plane: per-plane information; do not change */ enum vb2_buffer_state state; unsigned int synced:1;
The documented struct member is called "planes" rather than "vb2_plane". While at it, make the comments order follow struct members order. Fixes: 2b1413245550 ("media: vb2-core: Improve kernel-doc markups") Signed-off-by: Andrzej Pietrasiewicz <andrzej.p@collabora.com> --- include/media/videobuf2-core.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)