drm/sched: Fix kernel-doc warning for drm_sched_job_done()

Yujie-Liu · Philipp Stanner · commit 61ded1083b26 · 2026-03-04T10:29:27.000+01:00
There is a kernel-doc warning for the scheduler: Warning: drivers/gpu/drm/scheduler/sched_main.c:367 function parameter 'result' not described in 'drm_sched_job_done' Fix the warning by describing the undocumented error code. Fixes: 539f9ee ("drm/scheduler: properly forward fence errors") Signed-off-by: Yujie Liu <yujie.liu@intel.com> [phasta: Flesh out commit message] Signed-off-by: Philipp Stanner <phasta@kernel.org> Link: https://patch.msgid.link/20260227082452.1802922-1-yujie.liu@intel.com
diff --git 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: 0 on success, -ERRNO on error
  *
  * Finish the job's fence and resubmit the work items.
  */

Original file line number	Diff line number	Diff line change
`@@ -361,6 +361,7 @@ static void drm_sched_run_free_queue(struct drm_gpu_scheduler *sched)`
`361`	`361`	`/**`
`362`	`362`	`* drm_sched_job_done - complete a job`
`363`	`363`	`* @s_job: pointer to the job which is done`
	`364`	`+ * @result: 0 on success, -ERRNO on error`
`364`	`365`	`*`
`365`	`366`	`* Finish the job's fence and resubmit the work items.`
`366`	`367`	`*/`