From: Randy Dunlap <rdunlap@infradead.org>
To: Andrey Grodzovsky <andrey.grodzovsky@amd.com>,
linux-kernel@vger.kernel.org
Cc: "David Airlie" <airlied@linux.ie>,
"Jiawei Gu" <Jiawei.Gu@amd.com>,
dri-devel@lists.freedesktop.org,
"Alex Deucher" <alexander.deucher@amd.com>,
"Nayan Deshmukh" <nayan26deshmukh@gmail.com>,
"Christian König" <christian.koenig@amd.com>
Subject: Re: [PATCH v2] drm/scheduler: quieten kernel-doc warnings
Date: Wed, 31 Aug 2022 11:34:56 -0700 [thread overview]
Message-ID: <e61a6903-550d-df70-6297-f49cc2750244@infradead.org> (raw)
In-Reply-To: <68961bab-6448-9a98-8916-9c3cb0c5d020@amd.com>
ping?
On 4/4/22 14:58, Andrey Grodzovsky wrote:
> Reviewed-by: Andrey Grodzovsky <andrey.grodzovsky@amd.com>
> Andrey
>
> On 2022-04-04 17:30, Randy Dunlap wrote:
>> Fix kernel-doc warnings in gpu_scheduler.h and sched_main.c.
>>
>> Quashes these warnings:
>>
>> include/drm/gpu_scheduler.h:332: warning: missing initial short description on line:
>> * struct drm_sched_backend_ops
>> include/drm/gpu_scheduler.h:412: warning: missing initial short description on line:
>> * struct drm_gpu_scheduler
>> include/drm/gpu_scheduler.h:461: warning: Function parameter or member 'dev' not described in 'drm_gpu_scheduler'
>>
>> drivers/gpu/drm/scheduler/sched_main.c:201: warning: missing initial short description on line:
>> * drm_sched_dependency_optimized
>> drivers/gpu/drm/scheduler/sched_main.c:995: warning: Function parameter or member 'dev' not described in 'drm_sched_init'
>>
>> Fixes: 2d33948e4e00 ("drm/scheduler: add documentation")
>> Fixes: 8ab62eda177b ("drm/sched: Add device pointer to drm_gpu_scheduler")
>> Fixes: 542cff7893a3 ("drm/sched: Avoid lockdep spalt on killing a processes")
>> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
>> Cc: David Airlie <airlied@linux.ie>
>> Cc: Daniel Vetter <daniel@ffwll.ch>
>> Cc: Andrey Grodzovsky <andrey.grodzovsky@amd.com>
>> Cc: Nayan Deshmukh <nayan26deshmukh@gmail.com>
>> Cc: Alex Deucher <alexander.deucher@amd.com>
>> Cc: Christian König <christian.koenig@amd.com>
>> Cc: Jiawei Gu <Jiawei.Gu@amd.com>
>> Cc: dri-devel@lists.freedesktop.org
>> Acked-by: Christian König <christian.koenig@amd.com>
>> ---
>> Feel free to make changes or suggest changes...
>>
>> v2: drop @work description (already done by Andrey)
>>
>> drivers/gpu/drm/scheduler/sched_main.c | 3 ++-
>> include/drm/gpu_scheduler.h | 9 +++++----
>> 2 files changed, 7 insertions(+), 5 deletions(-)
>>
>> --- linux-next-20220404.orig/drivers/gpu/drm/scheduler/sched_main.c
>> +++ linux-next-20220404/drivers/gpu/drm/scheduler/sched_main.c
>> @@ -198,7 +198,7 @@ static void drm_sched_job_done_cb(struct
>> }
>> /**
>> - * drm_sched_dependency_optimized
>> + * drm_sched_dependency_optimized - test if the dependency can be optimized
>> *
>> * @fence: the dependency fence
>> * @entity: the entity which depends on the above fence
>> @@ -984,6 +984,7 @@ static int drm_sched_main(void *param)
>> * used
>> * @score: optional score atomic shared with other schedulers
>> * @name: name used for debugging
>> + * @dev: target &struct device
>> *
>> * Return 0 on success, otherwise error code.
>> */
>> --- linux-next-20220404.orig/include/drm/gpu_scheduler.h
>> +++ linux-next-20220404/include/drm/gpu_scheduler.h
>> @@ -328,10 +328,10 @@ enum drm_gpu_sched_stat {
>> };
>> /**
>> - * struct drm_sched_backend_ops
>> + * struct drm_sched_backend_ops - Define the backend operations
>> + * called by the scheduler
>> *
>> - * Define the backend operations called by the scheduler,
>> - * these functions should be implemented in driver side.
>> + * These functions should be implemented in the driver side.
>> */
>> struct drm_sched_backend_ops {
>> /**
>> @@ -408,7 +408,7 @@ struct drm_sched_backend_ops {
>> };
>> /**
>> - * struct drm_gpu_scheduler
>> + * struct drm_gpu_scheduler - scheduler instance-specific data
>> *
>> * @ops: backend operations provided by the driver.
>> * @hw_submission_limit: the max size of the hardware queue.
>> @@ -434,6 +434,7 @@ struct drm_sched_backend_ops {
>> * @_score: score used when the driver doesn't provide one
>> * @ready: marks if the underlying HW is ready to work
>> * @free_guilty: A hit to time out handler to free the guilty job.
>> + * @dev: system &struct device
>> *
>> * One scheduler is implemented for each hardware ring.
>> */
--
~Randy
next prev parent reply other threads:[~2022-08-31 18:35 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-04-04 21:30 [PATCH v2] drm/scheduler: quieten kernel-doc warnings Randy Dunlap
2022-04-04 21:58 ` Andrey Grodzovsky
2022-08-31 18:34 ` Randy Dunlap [this message]
2022-09-06 17:38 ` Andrey Grodzovsky
2022-09-06 17:57 ` Alex Deucher
2022-09-06 21:01 ` Andrey Grodzovsky
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=e61a6903-550d-df70-6297-f49cc2750244@infradead.org \
--to=rdunlap@infradead.org \
--cc=Jiawei.Gu@amd.com \
--cc=airlied@linux.ie \
--cc=alexander.deucher@amd.com \
--cc=andrey.grodzovsky@amd.com \
--cc=christian.koenig@amd.com \
--cc=dri-devel@lists.freedesktop.org \
--cc=linux-kernel@vger.kernel.org \
--cc=nayan26deshmukh@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).