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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <CAB3Z9RJPdCu50esK2mg9NkVihuWmZn7hpDdxeMEN1FBNpFtBrg@mail.gmail.com>
Date: Tue, 16 Sep 2025 06:52:19 +0800
From: Luc Ma <onion0709@...il.com>
To: phasta@...nel.org
Cc: dri-devel@...ts.freedesktop.org, Matthew Brost <matthew.brost@...el.com>, 
	Danilo Krummrich <dakr@...nel.org>, Christian König <ckoenig.leichtzumerken@...il.com>, 
	David Airlie <airlied@...il.com>, Simona Vetter <simona@...ll.ch>, linux-kernel@...r.kernel.org
Subject: Re: [PATCH] drm/sched: struct member doc fix

Hi,

On Mon, 15 Sept 2025 at 20:12, Philipp Stanner <phasta@...lbox.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@...il.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