[PATCH] drm/rect: update kerneldoc for drm_rect_clip_scaled()

[Ville Syrjälä]

On Tue, Nov 26, 2019 at 03:52:13PM +0100, Daniel Vetter wrote:
> This was forgotten in f96bdf564f3e ("drm/rect: Handle rounding errors
> in drm_rect_clip_scaled, v3.")
> 
> Spotted while reviewing patches from Ville touching this area.
> 
> Fixes: f96bdf564f3e ("drm/rect: Handle rounding errors in drm_rect_clip_scaled, v3.")
> Cc: Maarten Lankhorst <maarten.lankhorst at linux.intel.com>
> Cc: Benjamin Gaignard <benjamin.gaignard at st.com>
> Cc: Ville Syrjala <ville.syrjala at linux.intel.com>
> Signed-off-by: Daniel Vetter <daniel.vetter at intel.com>

Reviewed-by: Ville Syrjälä <ville.syrjala at linux.intel.com>

> ---
>  drivers/gpu/drm/drm_rect.c | 6 ++++--
>  1 file changed, 4 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/gpu/drm/drm_rect.c b/drivers/gpu/drm/drm_rect.c
> index b8363aaa9032..e6e640f2d5e3 100644
> --- a/drivers/gpu/drm/drm_rect.c
> +++ b/drivers/gpu/drm/drm_rect.c
> @@ -73,11 +73,13 @@ static u32 clip_scaled(u32 src, u32 dst, u32 clip)
>   * @clip: clip rectangle
>   *
>   * Clip rectangle @dst by rectangle @clip. Clip rectangle @src by the
> - * same amounts multiplied by @hscale and @vscale.
> + * the corresponding amounts, retaining the vertical and horizontal scaling
> + * factors from @src to @dst.
>   *
>   * RETURNS:
> + *
>   * %true if rectangle @dst is still visible after being clipped,
> - * %false otherwise
> + * %false otherwise.
>   */
>  bool drm_rect_clip_scaled(struct drm_rect *src, struct drm_rect *dst,
>  			  const struct drm_rect *clip)
> -- 
> 2.24.0

-- 
Ville Syrjälä
Intel