Assorted kernel-doc fixes

[PATCH 12/14] drm/scheduler: Describe @result in drm_sched_job_done()

Posted by Bagas Sanjaya 11 hours ago

Sphinx reports kernel-doc warning:

WARNING: ./drivers/gpu/drm/scheduler/sched_main.c:367 function parameter 'result' not described in 'drm_sched_job_done'

Describe @result parameter to fix it.

Fixes: 539f9ee4b52a8b ("drm/scheduler: properly forward fence errors")
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 drivers/gpu/drm/scheduler/sched_main.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/drivers/gpu/drm/scheduler/sched_main.c b/drivers/gpu/drm/scheduler/sched_main.c
index 1d4f1b822e7b76..4f844087fd48eb 100644
--- a/drivers/gpu/drm/scheduler/sched_main.c
+++ b/drivers/gpu/drm/scheduler/sched_main.c
@@ -361,6 +361,7 @@ static void drm_sched_run_free_queue(struct drm_gpu_scheduler *sched)
 /**
  * drm_sched_job_done - complete a job
  * @s_job: pointer to the job which is done
+ * @result: job result
  *
  * Finish the job's fence and resubmit the work items.
  */
-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH 12/14] drm/scheduler: Describe @result in drm_sched_job_done()

Posted by Philipp Stanner 11 hours ago

nit about commit title:
We use "drm/sched:" as prefix nowadays

On Mon, 2025-12-15 at 18:39 +0700, Bagas Sanjaya wrote:
> Sphinx reports kernel-doc warning:
> 
> WARNING: ./drivers/gpu/drm/scheduler/sched_main.c:367 function parameter 'result' not described in 'drm_sched_job_done'
> 
> Describe @result parameter to fix it
> 

Thx for fixing this!

> .
> 
> Fixes: 539f9ee4b52a8b ("drm/scheduler: properly forward fence errors")
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
>  drivers/gpu/drm/scheduler/sched_main.c | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/drivers/gpu/drm/scheduler/sched_main.c b/drivers/gpu/drm/scheduler/sched_main.c
> index 1d4f1b822e7b76..4f844087fd48eb 100644
> --- a/drivers/gpu/drm/scheduler/sched_main.c
> +++ b/drivers/gpu/drm/scheduler/sched_main.c
> @@ -361,6 +361,7 @@ static void drm_sched_run_free_queue(struct drm_gpu_scheduler *sched)
>  /**
>   * drm_sched_job_done - complete a job
>   * @s_job: pointer to the job which is done
> + * @result: job result

"error code for the job's finished-fence" would be a bit better and
more verbose.

With that:

Reviewed-by: Philipp Stanner <phasta@kernel.org>

>   *
>   * Finish the job's fence and resubmit the work items.
>   */