[PATCH 3/5] drm/atomic: Rework the object doc a bit

[Daniel Vetter]

On Mon, Dec 04, 2023 at 01:17:05PM +0100, Maxime Ripard wrote:
> The doc for the planes, crtcs, connectors and private_objs fields
> mention that they are pointers to an array of structures with
> per-$OBJECT data.
> 
> While these fields are indeed pointers to an array, each item of that
> array contain a pointer to the object structure affected by the update,
> and its old and new state. There's no per-object data there.
> 
> Let's rephrase those fields a bit to better match the current situation.

Yeah that wasn't updated as part of 5d943aa6c0d4 ("drm: Consolidate crtc
arrays in drm_atomic_state") and b8b5342b699b ("drm: Consolidate plane
arrays in drm_atomic_state"). With that added to the commit message:

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

> 
> Signed-off-by: Maxime Ripard <mripard at kernel.org>
> ---
>  include/drm/drm_atomic.h | 20 ++++++++++++++++----
>  1 file changed, 16 insertions(+), 4 deletions(-)
> 
> diff --git a/include/drm/drm_atomic.h b/include/drm/drm_atomic.h
> index 13cecdc1257d..914574b58ae7 100644
> --- a/include/drm/drm_atomic.h
> +++ b/include/drm/drm_atomic.h
> @@ -403,12 +403,18 @@ struct drm_atomic_state {
>  	bool duplicated : 1;
>  
>  	/**
> -	 * @planes: pointer to array of structures with per-plane data
> +	 * @planes:
> +	 *
> +	 * Pointer to array of @drm_plane and @drm_plane_state part of this
> +	 * update.
>  	 */
>  	struct __drm_planes_state *planes;
>  
>  	/**
> -	 * @crtcs: pointer to array of CRTC pointers
> +	 * @crtcs:
> +	 *
> +	 * Pointer to array of @drm_crtc and @drm_crtc_state part of this
> +	 * update.
>  	 */
>  	struct __drm_crtcs_state *crtcs;
>  
> @@ -418,7 +424,10 @@ struct drm_atomic_state {
>  	int num_connector;
>  
>  	/**
> -	 * @connectors: pointer to array of structures with per-connector data
> +	 * @connectors:
> +	 *
> +	 * Pointer to array of @drm_connector and @drm_connector_state part of
> +	 * this update.
>  	 */
>  	struct __drm_connnectors_state *connectors;
>  
> @@ -428,7 +437,10 @@ struct drm_atomic_state {
>  	int num_private_objs;
>  
>  	/**
> -	 * @private_objs: pointer to array of private object pointers
> +	 * @private_objs:
> +	 *
> +	 * Pointer to array of @drm_private_obj and @drm_private_obj_state part
> +	 * of this update.
>  	 */
>  	struct __drm_private_objs_state *private_objs;
>  
> -- 
> 2.43.0
> 

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