The documentation for drm_sched_backend_ops.run_job() details that that callback can be invoked multiple times by the deprecated function drm_sched_resubmit_jobs(). It also contains an unresolved TODO.
It is not useful to document side effects of a different, deprecated function in the docu of run_job(): Existing users won't re-evaluate their usage of the deprecated function by reading the non-deprecated one, and new users must not use the deprecated function in the first place. Remove the out of place documentation. Signed-off-by: Philipp Stanner <[email protected]> --- include/drm/gpu_scheduler.h | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/include/drm/gpu_scheduler.h b/include/drm/gpu_scheduler.h index fb88301b3c45..9c629bbc0684 100644 --- a/include/drm/gpu_scheduler.h +++ b/include/drm/gpu_scheduler.h @@ -429,16 +429,6 @@ struct drm_sched_backend_ops { * * @sched_job: the job to run * - * The deprecated drm_sched_resubmit_jobs() (called by &struct - * drm_sched_backend_ops.timedout_job) can invoke this again with the - * same parameters. Using this is discouraged because it violates - * dma_fence rules, notably dma_fence_init() has to be called on - * already initialized fences for a second time. Moreover, this is - * dangerous because attempts to allocate memory might deadlock with - * memory management code waiting for the reset to complete. - * - * TODO: Document what drivers should do / use instead. - * * This method is called in a workqueue context - either from the * submit_wq the driver passed through drm_sched_init(), or, if the * driver passed NULL, a separate, ordered workqueue the scheduler -- 2.49.0
