Re: [PATCH] A simple doc fix

[Andrey Grodzovsky]

On 2022-09-14 06:36, Anup K Parikh wrote:
> Fix two warnings during doc build which also results in corresponding
> additions in generated docs
>
> Warnings Fixed:
> 1. include/drm/gpu_scheduler.h:462: warning: Function parameter or member
>     'dev' not described in 'drm_gpu_scheduler'
> 2. drivers/gpu/drm/scheduler/sched_main.c:1005: warning: Function
>     parameter or member 'dev' not described in 'drm_sched_init'
>
> Signed-off-by: Anup K Parikh <parikhanupk.foss@xxxxxxxxx>
> ---
>   drivers/gpu/drm/scheduler/sched_main.c | 1 +
>   include/drm/gpu_scheduler.h            | 1 +
>   2 files changed, 2 insertions(+)
>
> diff --git a/drivers/gpu/drm/scheduler/sched_main.c b/drivers/gpu/drm/scheduler/sched_main.c
> index 68317d3a7a27..875d00213849 100644
> --- a/drivers/gpu/drm/scheduler/sched_main.c
> +++ b/drivers/gpu/drm/scheduler/sched_main.c
> @@ -994,6 +994,7 @@ static int drm_sched_main(void *param)
>    *		used
>    * @score: optional score atomic shared with other schedulers
>    * @name: name used for debugging
> + * @dev: A device pointer for use in error reporting in a multiple GPU scenario.


Why multiple GPUs scenario ? It's also used in single GPU scenario.

Andrey


>    *
>    * Return 0 on success, otherwise error code.
>    */
> diff --git a/include/drm/gpu_scheduler.h b/include/drm/gpu_scheduler.h
> index addb135eeea6..920b91fd1719 100644
> --- a/include/drm/gpu_scheduler.h
> +++ b/include/drm/gpu_scheduler.h
> @@ -435,6 +435,7 @@ struct drm_sched_backend_ops {
>    * @_score: score used when the driver doesn't provide one
>    * @ready: marks if the underlying HW is ready to work
>    * @free_guilty: A hit to time out handler to free the guilty job.
> + * @dev: A device pointer for use in error reporting in a multiple GPU scenario.
>    *
>    * One scheduler is implemented for each hardware ring.
>    */