[Intel-gfx] [PATCH] drm/doc: Fix documentation for _vblank_restore().

[Daniel Vetter]

On Tue, Feb 20, 2018 at 11:39:08PM -0800, Dhinakaran Pandiyan wrote:
> No code changes, fixes doc build warnings and polish some doc text.
> 
> Reported-by: Daniel Vetter <daniel.vetter at ffwll.ch>
> Cc: Rodrigo Vivi <rodrigo.vivi at intel.com>
> Cc: Daniel Vetter <daniel.vetter at ffwll.ch>
> Signed-off-by: Dhinakaran Pandiyan <dhinakaran.pandiyan at intel.com>

Thanks for the quick follow-up. Patch applied.
-Daniel

> ---
>  drivers/gpu/drm/drm_vblank.c | 22 ++++++++++++++--------
>  1 file changed, 14 insertions(+), 8 deletions(-)
> 
> diff --git a/drivers/gpu/drm/drm_vblank.c b/drivers/gpu/drm/drm_vblank.c
> index c781cb426bf1..51041eec0047 100644
> --- a/drivers/gpu/drm/drm_vblank.c
> +++ b/drivers/gpu/drm/drm_vblank.c
> @@ -1238,12 +1238,15 @@ void drm_crtc_vblank_on(struct drm_crtc *crtc)
>  EXPORT_SYMBOL(drm_crtc_vblank_on);
>  
>  /**
> - * drm_vblank_restore - estimated vblanks using timestamps and update it.
> + * drm_vblank_restore - estimate missed vblanks and update vblank count.
> + * @dev: DRM device
> + * @pipe: CRTC index
>   *
>   * Power manamement features can cause frame counter resets between vblank
> - * disable and enable. Drivers can then use this function in their
> - * &drm_crtc_funcs.enable_vblank implementation to estimate the vblanks since
> - * the last &drm_crtc_funcs.disable_vblank.
> + * disable and enable. Drivers can use this function in their
> + * &drm_crtc_funcs.enable_vblank implementation to estimate missed vblanks since
> + * the last &drm_crtc_funcs.disable_vblank using timestamps and update the
> + * vblank counter.
>   *
>   * This function is the legacy version of drm_crtc_vblank_restore().
>   */
> @@ -1284,11 +1287,14 @@ void drm_vblank_restore(struct drm_device *dev, unsigned int pipe)
>  EXPORT_SYMBOL(drm_vblank_restore);
>  
>  /**
> - * drm_crtc_vblank_restore - estimate vblanks using timestamps and update it.
> + * drm_crtc_vblank_restore - estimate missed vblanks and update vblank count.
> + * @crtc: CRTC in question
> + *
>   * Power manamement features can cause frame counter resets between vblank
> - * disable and enable. Drivers can then use this function in their
> - * &drm_crtc_funcs.enable_vblank implementation to estimate the vblanks since
> - * the last &drm_crtc_funcs.disable_vblank.
> + * disable and enable. Drivers can use this function in their
> + * &drm_crtc_funcs.enable_vblank implementation to estimate missed vblanks since
> + * the last &drm_crtc_funcs.disable_vblank using timestamps and update the
> + * vblank counter.
>   */
>  void drm_crtc_vblank_restore(struct drm_crtc *crtc)
>  {
> -- 
> 2.14.1
> 

-- 
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch