2023-05-15 06:11:33

by Mauro Carvalho Chehab

Subject: [PATCH] media: v4l2-subdev.h: document client_caps at struct v4l2_subdev_fh

Gets rid of this documentation warning:

./include/media/v4l2-subdev.h:1130: warning: Function parameter or member 'client_caps' not described in 'v4l2_subdev_fh'

By adding a documentation about such new field.

Fixes: f57fa2959244 ("media: v4l2-subdev: Add new ioctl for client capabilities")
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
include/media/v4l2-subdev.h | 3 +++
1 file changed, 3 insertions(+)

diff --git a/include/media/v4l2-subdev.h b/include/media/v4l2-subdev.h
index cfd19e72d0fc..62362da0d604 100644
--- a/include/media/v4l2-subdev.h
+++ b/include/media/v4l2-subdev.h
@@ -1119,6 +1119,9 @@ struct v4l2_subdev {
* @vfh: pointer to &struct v4l2_fh
* @state: pointer to &struct v4l2_subdev_state
* @owner: module pointer to the owner of this file handle
+ * @client_caps:
+ * client capabilities to inform the kernel of the behavior
+ * of the client as set by VIDIOC_SUBDEV_S_CLIENT_CAP.
*/
struct v4l2_subdev_fh {
struct v4l2_fh vfh;
--
2.40.1

2023-05-15 07:30:56

by Sakari Ailus

Subject: Re: [PATCH] media: v4l2-subdev.h: document client_caps at struct v4l2_subdev_fh

Hi Mauro,

On Mon, May 15, 2023 at 07:01:11AM +0100, Mauro Carvalho Chehab wrote:
> Gets rid of this documentation warning:
>
> ./include/media/v4l2-subdev.h:1130: warning: Function parameter or member 'client_caps' not described in 'v4l2_subdev_fh'
>
> By adding a documentation about such new field.
>
> Fixes: f57fa2959244 ("media: v4l2-subdev: Add new ioctl for client capabilities")
> Signed-off-by: Mauro Carvalho Chehab <[email protected]>

Tomi has sent a patch for this which I'm planning to include in my next PR:

<URL:https://lore.kernel.org/linux-media/[email protected]/#t>

--
Regards,

Sakari Ailus