[PATCH] drm: Fix comment making reference to non-existing function

[PATCH] drm: Fix comment making reference to non-existing function

[Liviu Dudau]

Documentation for drm_atomic_crtc_for_each_plane() makes reference to
a function called drm_crtc_for_each_pending_plane(). I've guessed that
the actual function name is drm_atomic_crtc_state_for_each_plane() as
that matches best the intent of the comment.

Signed-off-by: Liviu Dudau <Liviu.Dudau@arm.com>
---
 include/drm/drm_atomic_helper.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/drm/drm_atomic_helper.h b/include/drm/drm_atomic_helper.h
index 31c11e3..367457a 100644
--- a/include/drm/drm_atomic_helper.h
+++ b/include/drm/drm_atomic_helper.h
@@ -167,7 +167,7 @@ void drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc,
  * This iterates over the current state, useful (for example) when applying
  * atomic state after it has been checked and swapped.  To iterate over the
  * planes which *will* be attached (for ->atomic_check()) see
- * drm_crtc_for_each_pending_plane().
+ * drm_atomic_crtc_state_for_each_plane().
  */
 #define drm_atomic_crtc_for_each_plane(plane, crtc) \
 	drm_for_each_plane_mask(plane, (crtc)->dev, (crtc)->state->plane_mask)
-- 
2.8.2

Re: [PATCH] drm: Fix comment making reference to non-existing function

[Daniel Vetter]

On Fri, Jun 10, 2016 at 04:03:25PM +0100, Liviu Dudau wrote:
> Documentation for drm_atomic_crtc_for_each_plane() makes reference to
> a function called drm_crtc_for_each_pending_plane(). I've guessed that
> the actual function name is drm_atomic_crtc_state_for_each_plane() as
> that matches best the intent of the comment.
> 
> Signed-off-by: Liviu Dudau <Liviu.Dudau@arm.com>

Good catch. Iirc one of the earlier versions of these was called pending,
but then we passed the state in explicitly. Applied to drm-misc, thanks.
-Daniel

> ---
>  include/drm/drm_atomic_helper.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/include/drm/drm_atomic_helper.h b/include/drm/drm_atomic_helper.h
> index 31c11e3..367457a 100644
> --- a/include/drm/drm_atomic_helper.h
> +++ b/include/drm/drm_atomic_helper.h
> @@ -167,7 +167,7 @@ void drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc,
>   * This iterates over the current state, useful (for example) when applying
>   * atomic state after it has been checked and swapped.  To iterate over the
>   * planes which *will* be attached (for ->atomic_check()) see
> - * drm_crtc_for_each_pending_plane().
> + * drm_atomic_crtc_state_for_each_plane().
>   */
>  #define drm_atomic_crtc_for_each_plane(plane, crtc) \
>  	drm_for_each_plane_mask(plane, (crtc)->dev, (crtc)->state->plane_mask)
> -- 
> 2.8.2
> 

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