diff mbox series

[v2] drm/bridge: Fix returned array size name for atomic_get_input_bus_fmts kdoc

Message ID 20230314055035.3731179-1-victor.liu@nxp.com (mailing list archive)
State New, archived
Headers show
Series [v2] drm/bridge: Fix returned array size name for atomic_get_input_bus_fmts kdoc | expand

Commit Message

Liu Ying March 14, 2023, 5:50 a.m. UTC
The returned array size for input formats is set through
atomic_get_input_bus_fmts()'s 'num_input_fmts' argument, so use
'num_input_fmts' to represent the array size in the function's kdoc,
not 'num_output_fmts'.

Fixes: 91ea83306bfa ("drm/bridge: Fix the bridge kernel doc")
Fixes: f32df58acc68 ("drm/bridge: Add the necessary bits to support bus format negotiation")
Signed-off-by: Liu Ying <victor.liu@nxp.com>
---
v1->v2:
* Correct Fixes tag format.
* Copy DRM bridge driver maintainers.
* Copy Boris.

 include/drm/drm_bridge.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Robert Foss March 14, 2023, 9:09 a.m. UTC | #1
On Tue, Mar 14, 2023 at 6:45 AM Liu Ying <victor.liu@nxp.com> wrote:
>
> The returned array size for input formats is set through
> atomic_get_input_bus_fmts()'s 'num_input_fmts' argument, so use
> 'num_input_fmts' to represent the array size in the function's kdoc,
> not 'num_output_fmts'.
>
> Fixes: 91ea83306bfa ("drm/bridge: Fix the bridge kernel doc")
> Fixes: f32df58acc68 ("drm/bridge: Add the necessary bits to support bus format negotiation")
> Signed-off-by: Liu Ying <victor.liu@nxp.com>
> ---
> v1->v2:
> * Correct Fixes tag format.
> * Copy DRM bridge driver maintainers.
> * Copy Boris.
>
>  include/drm/drm_bridge.h | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/include/drm/drm_bridge.h b/include/drm/drm_bridge.h
> index 42f86327b40a..bf964cdfb330 100644
> --- a/include/drm/drm_bridge.h
> +++ b/include/drm/drm_bridge.h
> @@ -423,11 +423,11 @@ struct drm_bridge_funcs {
>          *
>          * The returned array must be allocated with kmalloc() and will be
>          * freed by the caller. If the allocation fails, NULL should be
> -        * returned. num_output_fmts must be set to the returned array size.
> +        * returned. num_input_fmts must be set to the returned array size.
>          * Formats listed in the returned array should be listed in decreasing
>          * preference order (the core will try all formats until it finds one
>          * that works). When the format is not supported NULL should be
> -        * returned and num_output_fmts should be set to 0.
> +        * returned and num_input_fmts should be set to 0.
>          *
>          * This method is called on all elements of the bridge chain as part of
>          * the bus format negotiation process that happens in
> --
> 2.37.1
>

Reviewed-by: Robert Foss <rfoss@kernel.org>
Neil Armstrong March 15, 2023, 9:10 a.m. UTC | #2
Hi,

On Tue, 14 Mar 2023 13:50:35 +0800, Liu Ying wrote:
> The returned array size for input formats is set through
> atomic_get_input_bus_fmts()'s 'num_input_fmts' argument, so use
> 'num_input_fmts' to represent the array size in the function's kdoc,
> not 'num_output_fmts'.
> 
> 

Thanks, Applied to https://anongit.freedesktop.org/git/drm/drm-misc.git (drm-misc-fixes)

[1/1] drm/bridge: Fix returned array size name for atomic_get_input_bus_fmts kdoc
      https://cgit.freedesktop.org/drm/drm-misc/commit/?id=0d3c9333d976af41d7dbc6bf4d9d2e95fbdf9c89
diff mbox series

Patch

diff --git a/include/drm/drm_bridge.h b/include/drm/drm_bridge.h
index 42f86327b40a..bf964cdfb330 100644
--- a/include/drm/drm_bridge.h
+++ b/include/drm/drm_bridge.h
@@ -423,11 +423,11 @@  struct drm_bridge_funcs {
 	 *
 	 * The returned array must be allocated with kmalloc() and will be
 	 * freed by the caller. If the allocation fails, NULL should be
-	 * returned. num_output_fmts must be set to the returned array size.
+	 * returned. num_input_fmts must be set to the returned array size.
 	 * Formats listed in the returned array should be listed in decreasing
 	 * preference order (the core will try all formats until it finds one
 	 * that works). When the format is not supported NULL should be
-	 * returned and num_output_fmts should be set to 0.
+	 * returned and num_input_fmts should be set to 0.
 	 *
 	 * This method is called on all elements of the bridge chain as part of
 	 * the bus format negotiation process that happens in