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

Fixes: 539f9ee4b52a ("drm/scheduler: properly forward fence errors")
Signed-off-by: Yujie Liu <yujie.liu@intel.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 e6ee35406165..fe4c1017734b 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: 0 on success; -errno on failure
  *
  * Finish the job's fence and resubmit the work items.
  */
-- 
2.43.0

On Thu, 2026-02-26 at 11:00 +0800, Yujie Liu wrote:
> Warning: drivers/gpu/drm/scheduler/sched_main.c:367 function parameter 'result' not described in 'drm_sched_job_done'
> 
> Fixes: 539f9ee4b52a ("drm/scheduler: properly forward fence errors")
> Signed-off-by: Yujie Liu <yujie.liu@intel.com>

Thanks for fixing this!

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

> ---
>  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 e6ee35406165..fe4c1017734b 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: 0 on success; -errno on failure

nit: shouldn't it be -ERRNO? But idk.

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

On Fri, Feb 27, 2026 at 07:47:42AM +0100, Philipp Stanner wrote:
> On Thu, 2026-02-26 at 11:00 +0800, Yujie Liu wrote:
> > Warning: drivers/gpu/drm/scheduler/sched_main.c:367 function parameter 'result' not described in 'drm_sched_job_done'
> > 
> > Fixes: 539f9ee4b52a ("drm/scheduler: properly forward fence errors")
> > Signed-off-by: Yujie Liu <yujie.liu@intel.com>
> 
> Thanks for fixing this!
> 
> Acked-by: Philipp Stanner <phasta@kernel.org>

Hi Philipp,

Thanks for reviewing this.

Following Christian's suggestion to split this set into individual
patches for different subsystem branches, I've sent a v2 at [1] with
less audience. Sorry for bothering too many people on these minor
kernel-doc fixes.

[1] https://lore.kernel.org/all/20260227061052.1752354-1-yujie.liu@intel.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 e6ee35406165..fe4c1017734b 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: 0 on success; -errno on failure
> 
> nit: shouldn't it be -ERRNO? But idk.

Thanks, indeed it should be capital letters. Will respin a v3 with you
CC'd.

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