| Message ID | 20241217034915.62594-1-bagasdotme@gmail.com (mailing list archive) |
|---|---|
| State | New |
| Headers | show |
| Series | drm/sched: Separate drm_sched_fini() driver checklist | expand |
On Tue, 2024-12-17 at 10:49 +0700, Bagas Sanjaya wrote: > Commit baf4afc5831438 ("drm/sched: Improve teardown documentation") > documents drm_sched_fini() with a post-function call checklist for > drivers. The checklist triggers htmldocs warning (but renders > correctly > in htmldocs output): > > Documentation/gpu/drm-mm:571: > ./drivers/gpu/drm/scheduler/sched_main.c:1359: ERROR: Unexpected > indentation. > > Separate the checklist from preceding paragraph by a blank line to > fix > the warning. While at it, also end the aforementioned paragraph by a > colon. > > Fixes: baf4afc58314 ("drm/sched: Improve teardown documentation") > Reported-by: Stephen Rothwell <sfr@canb.auug.org.au> > Closes: > https://lore.kernel.org/r/20241108175655.6d3fcfb7@canb.auug.org.au/ > Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> Applied (with some adjustments to commit message), thank you P. > --- > drivers/gpu/drm/scheduler/sched_main.c | 3 ++- > 1 file changed, 2 insertions(+), 1 deletion(-) > > diff --git a/drivers/gpu/drm/scheduler/sched_main.c > b/drivers/gpu/drm/scheduler/sched_main.c > index 7ce25281c74ce5..57da84908752c6 100644 > --- a/drivers/gpu/drm/scheduler/sched_main.c > +++ b/drivers/gpu/drm/scheduler/sched_main.c > @@ -1355,7 +1355,8 @@ EXPORT_SYMBOL(drm_sched_init); > * drm_sched_backend_ops.run_job(). Consequently, > drm_sched_backend_ops.free_job() > * will not be called for all jobs still in > drm_gpu_scheduler.pending_list. > * There is no solution for this currently. Thus, it is up to the > driver to make > - * sure that > + * sure that: > + * > * a) drm_sched_fini() is only called after for all submitted jobs > * drm_sched_backend_ops.free_job() has been called or that > * b) the jobs for which drm_sched_backend_ops.free_job() has not > been called > > base-commit: d172ea67dbeec5c90f72752c91d202d5718e3754
diff --git a/drivers/gpu/drm/scheduler/sched_main.c b/drivers/gpu/drm/scheduler/sched_main.c index 7ce25281c74ce5..57da84908752c6 100644 --- a/drivers/gpu/drm/scheduler/sched_main.c +++ b/drivers/gpu/drm/scheduler/sched_main.c @@ -1355,7 +1355,8 @@ EXPORT_SYMBOL(drm_sched_init); * drm_sched_backend_ops.run_job(). Consequently, drm_sched_backend_ops.free_job() * will not be called for all jobs still in drm_gpu_scheduler.pending_list. * There is no solution for this currently. Thus, it is up to the driver to make - * sure that + * sure that: + * * a) drm_sched_fini() is only called after for all submitted jobs * drm_sched_backend_ops.free_job() has been called or that * b) the jobs for which drm_sched_backend_ops.free_job() has not been called
Commit baf4afc5831438 ("drm/sched: Improve teardown documentation") documents drm_sched_fini() with a post-function call checklist for drivers. The checklist triggers htmldocs warning (but renders correctly in htmldocs output): Documentation/gpu/drm-mm:571: ./drivers/gpu/drm/scheduler/sched_main.c:1359: ERROR: Unexpected indentation. Separate the checklist from preceding paragraph by a blank line to fix the warning. While at it, also end the aforementioned paragraph by a colon. Fixes: baf4afc58314 ("drm/sched: Improve teardown documentation") Reported-by: Stephen Rothwell <sfr@canb.auug.org.au> Closes: https://lore.kernel.org/r/20241108175655.6d3fcfb7@canb.auug.org.au/ Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> --- drivers/gpu/drm/scheduler/sched_main.c | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) base-commit: d172ea67dbeec5c90f72752c91d202d5718e3754