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

Luc Ma posted 1 patch 2 weeks, 3 days ago
include/drm/gpu_scheduler.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
[PATCH v2] drm/sched: struct member doc fix
Posted by Luc Ma 2 weeks, 3 days ago
The mentioned function has been renamed since commit 180fc134d712
("drm/scheduler: Rename cleanup functions v2."), so let it refer to
the current one.

v2: use proper pattern for function cross-reference

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..fb88301b3c45 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 v2] drm/sched: struct member doc fix
Posted by Philipp Stanner 2 weeks, 1 day ago
On Mon, 2025-09-15 at 21:23 +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.
> 
> v2: use proper pattern for function cross-reference
> 
> Signed-off-by: Luc Ma <onion0709@gmail.com>

Applied to drm-misc-next, thx.

For the next time: In drm/sched we agreed to not include change logs in
the commit messages because they aren't really useful.

P.

> ---
>  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..fb88301b3c45 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.