[PATCH v3] drm/scheduler: fix kernel-doc warning for drm_sched_job_done()

[PATCH v3] drm/scheduler: fix kernel-doc warning for drm_sched_job_done()

[Yujie Liu]

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>
---
Changes in v2:
- Split from the original patch set
  https://lore.kernel.org/all/20260226030038.1182961-1-yujie.liu@intel.com/
- Rebase onto latest drm-tip

Changes in v3:
- Change "errno" to uppercase "ERRNO" (suggested by Philipp)

 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..2d5cb21a05b6 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 error
  *
  * Finish the job's fence and resubmit the work items.
  */
-- 
2.43.0

Re: [PATCH v3] drm/scheduler: fix kernel-doc warning for drm_sched_job_done()

[Philipp Stanner]

On Fri, 2026-02-27 at 16:24 +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>

Pushed to drm-misc-fixes.

Thank you

P.

PS:
for the future, scripts/get_maintainer provides a list of all recipents
a patch should go to (two maintainers were missing). And a sentence or
two in commit messages to describe what is being done are desirable. I
added them for now, so no big deal. Just as a tip for the future :]

> ---
> Changes in v2:
> - Split from the original patch set
>   https://lore.kernel.org/all/20260226030038.1182961-1-yujie.liu@intel.com/
> - Rebase onto latest drm-tip
> 
> Changes in v3:
> - Change "errno" to uppercase "ERRNO" (suggested by Philipp)
> 
>  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..2d5cb21a05b6 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 error
>   *
>   * Finish the job's fence and resubmit the work items.
>   */

Re: [PATCH v3] drm/scheduler: fix kernel-doc warning for drm_sched_job_done()

[Yujie Liu]

On Wed, Mar 04, 2026 at 10:34:48AM +0100, Philipp Stanner wrote:
> On Fri, 2026-02-27 at 16:24 +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>
> 
> Pushed to drm-misc-fixes.
> 
> Thank you
> 
> P.
> 
> PS:
> for the future, scripts/get_maintainer provides a list of all recipents
> a patch should go to (two maintainers were missing). And a sentence or
> two in commit messages to describe what is being done are desirable. I
> added them for now, so no big deal. Just as a tip for the future :]

Thank you for the helpful tips. I did try scripts/get_maintainer.pl
which showed many recipients. I wasn't sure if such a minor kernel-doc
fix should be sent to so many maintainers, so I followed the same
recipient list as the commit in the "Fixes:" tag [1]. And yes I should
put some description words in commit message in addition to the plain
build warning, thanks for help adding this. I'll keep these nice tips
in mind for furture patches.

[1] https://lore.kernel.org/all/20230420115752.31470-1-christian.koenig@amd.com/

Yujie

> 
> > ---
> > Changes in v2:
> > - Split from the original patch set
> >   https://lore.kernel.org/all/20260226030038.1182961-1-yujie.liu@intel.com/
> > - Rebase onto latest drm-tip
> > 
> > Changes in v3:
> > - Change "errno" to uppercase "ERRNO" (suggested by Philipp)
> > 
> >  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..2d5cb21a05b6 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 error
> >   *
> >   * Finish the job's fence and resubmit the work items.
> >   */
>