[PATCH] drm/amdgpu: fix doc by clarifying sched_list definition

[Luben Tuikov]

That looks excellent--thank you for submitting it.

Hopefully, the documentation would be more accessible
to everyone, so that everyone would contribute.

Regards,
Luben

On 2020-01-20 11:35 a.m., Nirmoy Das wrote:
> expand sched_list definition for better understanding.
> Also fix a typo atleast -> at least
> 
> Signed-off-by: Nirmoy Das <nirmoy.das at amd.com>
> ---
>  drivers/gpu/drm/scheduler/sched_entity.c | 2 +-
>  include/drm/gpu_scheduler.h              | 5 +++--
>  2 files changed, 4 insertions(+), 3 deletions(-)
> 
> diff --git a/drivers/gpu/drm/scheduler/sched_entity.c b/drivers/gpu/drm/scheduler/sched_entity.c
> index ec79e8e5ad3c..63bccd201b97 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 sched_list should have atleast one element to schedule
> + * Note: the sched_list should have at least one element to schedule
>   *       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 9e71be129c30..9ebba61db177 100644
> --- a/include/drm/gpu_scheduler.h
> +++ b/include/drm/gpu_scheduler.h
> @@ -52,8 +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.
> - * @sched_list: a list of drm_gpu_schedulers on which jobs from this entity can
> - *              be scheduled
> + * @sched_list: A list of schedulers (drm_gpu_schedulers).
> + *              Jobs from this entity, can be scheduled on any scheduler
> + *              on this list.
>   * @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.
>