[PATCH] drm/sched: struct member doc fix

[PATCH] drm/sched: struct member doc fix

[Luc Ma]

The mentioned function has been renamed since commit 180fc134d712
("drm/scheduler: Rename cleanup functions v2."), so let it refer to
the current one.

Signed-off-by: Luc Ma <onion0709@gmail.com>
---
 include/drm/gpu_scheduler.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/drm/gpu_scheduler.h b/include/drm/gpu_scheduler.h
index 323a505e6e6a..6c4d0563e3d7 100644
--- a/include/drm/gpu_scheduler.h
+++ b/include/drm/gpu_scheduler.h
@@ -546,7 +546,7 @@ struct drm_sched_backend_ops {
  * @num_rqs: Number of run-queues. This is at most DRM_SCHED_PRIORITY_COUNT,
  *           as there's usually one run-queue per priority, but could be less.
  * @sched_rq: An allocated array of run-queues of size @num_rqs;
- * @job_scheduled: once @drm_sched_entity_do_release is called the scheduler
+ * @job_scheduled: once @drm_sched_entity_flush is called the scheduler
  *                 waits on this wait queue until all the scheduled jobs are
  *                 finished.
  * @job_id_count: used to assign unique id to the each job.
-- 
2.51.0

Re: [PATCH] drm/sched: struct member doc fix

[Philipp Stanner]

On Fri, 2025-09-12 at 21:44 +0800, Luc Ma wrote:
> The mentioned function has been renamed since commit 180fc134d712
> ("drm/scheduler: Rename cleanup functions v2."), so let it refer to
> the current one.
> 
> Signed-off-by: Luc Ma <onion0709@gmail.com>

Thx for the patch.

> ---
>  include/drm/gpu_scheduler.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/include/drm/gpu_scheduler.h b/include/drm/gpu_scheduler.h
> index 323a505e6e6a..6c4d0563e3d7 100644
> --- a/include/drm/gpu_scheduler.h
> +++ b/include/drm/gpu_scheduler.h
> @@ -546,7 +546,7 @@ struct drm_sched_backend_ops {
>   * @num_rqs: Number of run-queues. This is at most DRM_SCHED_PRIORITY_COUNT,
>   *           as there's usually one run-queue per priority, but could be less.
>   * @sched_rq: An allocated array of run-queues of size @num_rqs;
> - * @job_scheduled: once @drm_sched_entity_do_release is called the scheduler
> + * @job_scheduled: once @drm_sched_entity_flush is called the scheduler

The change itself looks correct to me; however, a function must be
cross-referenced with parenthesis: "once drm_sched_entity_flush() …"

'@' is used for function parameters.

https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html#highlights-and-cross-references

Please provide that change in a v2.

Thank you,
P.


>   *                 waits on this wait queue until all the scheduled jobs are
>   *                 finished.
>   * @job_id_count: used to assign unique id to the each job.

Re: [PATCH] drm/sched: struct member doc fix

[Luc Ma]

Hi,

On Mon, 15 Sept 2025 at 20:12, Philipp Stanner <phasta@mailbox.org> wrote:
>
> On Fri, 2025-09-12 at 21:44 +0800, Luc Ma wrote:
> > The mentioned function has been renamed since commit 180fc134d712
> > ("drm/scheduler: Rename cleanup functions v2."), so let it refer to
> > the current one.
> >
> > Signed-off-by: Luc Ma <onion0709@gmail.com>
>
> Thx for the patch.
>
> > ---
> >  include/drm/gpu_scheduler.h | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/include/drm/gpu_scheduler.h b/include/drm/gpu_scheduler.h
> > index 323a505e6e6a..6c4d0563e3d7 100644
> > --- a/include/drm/gpu_scheduler.h
> > +++ b/include/drm/gpu_scheduler.h
> > @@ -546,7 +546,7 @@ struct drm_sched_backend_ops {
> >   * @num_rqs: Number of run-queues. This is at most DRM_SCHED_PRIORITY_COUNT,
> >   *           as there's usually one run-queue per priority, but could be less.
> >   * @sched_rq: An allocated array of run-queues of size @num_rqs;
> > - * @job_scheduled: once @drm_sched_entity_do_release is called the scheduler
> > + * @job_scheduled: once @drm_sched_entity_flush is called the scheduler
>
> The change itself looks correct to me; however, a function must be
> cross-referenced with parenthesis: "once drm_sched_entity_flush() …"
>
> '@' is used for function parameters.
>
> https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html#highlights-and-cross-references
>
> Please provide that change in a v2.
Thank you for pointing out that, I'll send v2.

>
> Thank you,
> P.
>
>
> >   *                 waits on this wait queue until all the scheduled jobs are
> >   *                 finished.
> >   * @job_id_count: used to assign unique id to the each job.
>


-- 
Luc