[PATCH v4 1/3] media: v4l2-subdev: Fix v4l2_subdev_state_get_format() documentation

[Sakari Ailus]

Hi Laurent,

Thanks for posting this.

On Thu, May 09, 2024 at 12:40:43AM +0300, Laurent Pinchart wrote:
> The documentation of the v4l2_subdev_state_get_format() macro
> incorrectly references __v4l2_subdev_state_get_format() instead of
> __v4l2_subdev_state_gen_call(). Fix it, and also update the list of
> similar macros to add the missing v4l2_subdev_state_get_interval().
> 
> Suggested-by: Sakari Ailus <sakari.ailus at linux.intel.com>
> Signed-off-by: Laurent Pinchart <laurent.pinchart+renesas at ideasonboard.com>
> ---
>  include/media/v4l2-subdev.h | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/include/media/v4l2-subdev.h b/include/media/v4l2-subdev.h
> index e30c463d90e5..b25b6e97ecbd 100644
> --- a/include/media/v4l2-subdev.h
> +++ b/include/media/v4l2-subdev.h
> @@ -1340,12 +1340,12 @@ void v4l2_subdev_cleanup(struct v4l2_subdev *sd);
>   */
>  /*
>   * Wrap v4l2_subdev_state_get_format(), allowing the function to be called with
> - * two or three arguments. The purpose of the __v4l2_subdev_state_get_format()
> + * two or three arguments. The purpose of the __v4l2_subdev_state_gen_call()
>   * macro below is to come up with the name of the function or macro to call,

You could drop "below" here, too: the macro definition is above the text.

Reviewed-by: Sakari Ailus <sakari.ailus at linux.intel.com>

>   * using the last two arguments (_stream and _pad). The selected function or
>   * macro is then called using the arguments specified by the caller. A similar
> - * arrangement is used for v4l2_subdev_state_crop() and
> - * v4l2_subdev_state_compose() below.
> + * arrangement is used for v4l2_subdev_state_crop(), v4l2_subdev_state_compose()
> + * and v4l2_subdev_state_get_interval() below.
>   */
>  #define v4l2_subdev_state_get_format(state, pad, ...)			\
>  	__v4l2_subdev_state_gen_call(format, ##__VA_ARGS__, , _pad)	\

-- 
Sakari Ailus