drm/fourcc: Fix the parameters name in the documentation

Submitted by Maxime Ripard on May 21, 2019, 11:09 a.m.

Details

Message ID 20190521110906.15268-1-maxime.ripard@bootlin.com
State Accepted
Commit 7793a108964924dd2802ee8c5dff2e9f3a9cd54a
Headers show
Series "drm/fourcc: Fix the parameters name in the documentation" ( rev: 1 ) in DRI devel

Not browsing as part of any series.

Commit Message

Maxime Ripard May 21, 2019, 11:09 a.m.
We introduced new functions in the commit bf39607c1614 ("drm/fourcc: Pass
the format_info pointer to drm_format_plane_width/height") based on
previous ones but with a slightly different prototype. However, the
documentation wasn't changed to reflect that change.

Fixes: bf39607c1614 ("drm/fourcc: Pass the format_info pointer to drm_format_plane_width/height")
Reported-by: kbuild test robot <lkp@intel.com>
Signed-off-by: Maxime Ripard <maxime.ripard@bootlin.com>
---
 include/drm/drm_fourcc.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Patch hide | download patch | download mbox

diff --git a/include/drm/drm_fourcc.h b/include/drm/drm_fourcc.h
index 405466692bd2..306d1efeb5e0 100644
--- a/include/drm/drm_fourcc.h
+++ b/include/drm/drm_fourcc.h
@@ -262,7 +262,7 @@  drm_format_info_is_yuv_sampling_444(const struct drm_format_info *info)
 
 /**
  * drm_format_info_plane_width - width of the plane given the first plane
- * @format: pixel format info
+ * @info: pixel format info
  * @width: width of the first plane
  * @plane: plane index
  *
@@ -284,7 +284,7 @@  int drm_format_info_plane_width(const struct drm_format_info *info, int width,
 
 /**
  * drm_format_info_plane_height - height of the plane given the first plane
- * @format: pixel format info
+ * @info: pixel format info
  * @height: height of the first plane
  * @plane: plane index
  *

Comments

On Tue, May 21, 2019 at 01:09:06PM +0200, Maxime Ripard wrote:
> We introduced new functions in the commit bf39607c1614 ("drm/fourcc: Pass
> the format_info pointer to drm_format_plane_width/height") based on
> previous ones but with a slightly different prototype. However, the
> documentation wasn't changed to reflect that change.
> 
> Fixes: bf39607c1614 ("drm/fourcc: Pass the format_info pointer to drm_format_plane_width/height")
> Reported-by: kbuild test robot <lkp@intel.com>
> Signed-off-by: Maxime Ripard <maxime.ripard@bootlin.com>

Reviewed-by: Daniel Vetter <daniel.vetter@ffwll.ch>

> ---
>  include/drm/drm_fourcc.h | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/include/drm/drm_fourcc.h b/include/drm/drm_fourcc.h
> index 405466692bd2..306d1efeb5e0 100644
> --- a/include/drm/drm_fourcc.h
> +++ b/include/drm/drm_fourcc.h
> @@ -262,7 +262,7 @@ drm_format_info_is_yuv_sampling_444(const struct drm_format_info *info)
>  
>  /**
>   * drm_format_info_plane_width - width of the plane given the first plane
> - * @format: pixel format info
> + * @info: pixel format info
>   * @width: width of the first plane
>   * @plane: plane index
>   *
> @@ -284,7 +284,7 @@ int drm_format_info_plane_width(const struct drm_format_info *info, int width,
>  
>  /**
>   * drm_format_info_plane_height - height of the plane given the first plane
> - * @format: pixel format info
> + * @info: pixel format info
>   * @height: height of the first plane
>   * @plane: plane index
>   *
> -- 
> 2.21.0
> 
> _______________________________________________
> dri-devel mailing list
> dri-devel@lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/dri-devel