[PATCH] drm/scheduler: fix documentation by replacing rq_list with sched_list

[Luben Tuikov]

On 2020-01-16 09:43, Nirmoy Das wrote:
> This also replaces old artifacts with a correct one in drm_sched_entity_init()
> declaration
> 
> Signed-off-by: Nirmoy Das <nirmoy.das at amd.com>
> ---
>  drivers/gpu/drm/scheduler/sched_entity.c |  2 +-
>  include/drm/gpu_scheduler.h              | 10 +++++-----
>  2 files changed, 6 insertions(+), 6 deletions(-)
> 
> diff --git a/drivers/gpu/drm/scheduler/sched_entity.c b/drivers/gpu/drm/scheduler/sched_entity.c
> index 33e2cd1089a2..ec79e8e5ad3c 100644
> --- a/drivers/gpu/drm/scheduler/sched_entity.c
> +++ b/drivers/gpu/drm/scheduler/sched_entity.c
> @@ -45,7 +45,7 @@
>   * @guilty: atomic_t set to 1 when a job on this queue
>   *          is found to be guilty causing a timeout
>   *
> - * Note: the rq_list should have atleast one element to schedule
> + * Note: the sched_list should have atleast one element to schedule

"atleast" --> "at least".

>   *       the entity
>   *
>   * Returns 0 on success or a negative error code on failure.
> diff --git a/include/drm/gpu_scheduler.h b/include/drm/gpu_scheduler.h
> index 537f7a4655a5..9e71be129c30 100644
> --- a/include/drm/gpu_scheduler.h
> +++ b/include/drm/gpu_scheduler.h
> @@ -52,9 +52,9 @@ enum drm_sched_priority {
>   * @list: used to append this struct to the list of entities in the
>   *        runqueue.
>   * @rq: runqueue on which this entity is currently scheduled.
> - * @rq_list: a list of run queues on which jobs from this entity can
> - *           be scheduled
> - * @num_rq_list: number of run queues in the rq_list
> + * @sched_list: a list of drm_gpu_schedulers on which jobs from this entity can
> + *              be scheduled

I had to read this a few times to understand it. I wonder if splitting
it into two sentences would make it clearer:

"A list of schedulers (drm_gpu_schedulers). Jobs from this entity,
 can be scheduled on any scheduler on this list."

Regards,
Luben


> + * @num_sched_list: number of drm_gpu_schedulers in the sched_list.
>   * @rq_lock: lock to modify the runqueue to which this entity belongs.
>   * @job_queue: the list of jobs of this entity.
>   * @fence_seq: a linearly increasing seqno incremented with each
> @@ -81,8 +81,8 @@ enum drm_sched_priority {
>  struct drm_sched_entity {
>  	struct list_head		list;
>  	struct drm_sched_rq		*rq;
> -	unsigned int                    num_sched_list;
>  	struct drm_gpu_scheduler        **sched_list;
> +	unsigned int                    num_sched_list;
>  	enum drm_sched_priority         priority;
>  	spinlock_t			rq_lock;
>  
> @@ -315,7 +315,7 @@ void drm_sched_rq_remove_entity(struct drm_sched_rq *rq,
>  int drm_sched_entity_init(struct drm_sched_entity *entity,
>  			  enum drm_sched_priority priority,
>  			  struct drm_gpu_scheduler **sched_list,
> -			  unsigned int num_rq_list,
> +			  unsigned int num_sched_list,
>  			  atomic_t *guilty);
>  long drm_sched_entity_flush(struct drm_sched_entity *entity, long timeout);
>  void drm_sched_entity_fini(struct drm_sched_entity *entity);
>