drm/sched: Document purpose of drm_sched_{start,stop}drm-misc-next-2024-10-31
commit2e0757012cf4f3c29a671f0981f9aa853a96def6
authorPhilipp Stanner <pstanner@redhat.com>
Tue, 29 Oct 2024 13:38:20 +0000 (29 14:38 +0100)
committerPhilipp Stanner <pstanner@redhat.com>
Thu, 31 Oct 2024 11:48:49 +0000 (31 12:48 +0100)
treea0d5fb3ee96c498862cc5c7cdb31ea75ad8ab00d
parent766515ab5bba959fc8036e77e875a672916ba8fc
drm/sched: Document purpose of drm_sched_{start,stop}

drm_sched_start()'s and drm_sched_stop()'s names suggest that those
functions might be intended for actively starting and stopping the
scheduler on initialization and teardown.

They are, however, only used on timeout handling (reset recovery). The
docstrings should reflect that to prevent confusion.

Document those functions' purpose.

Reviewed-by: Alex Deucher <alexander.deucher@amd.com>
Signed-off-by: Philipp Stanner <pstanner@redhat.com>
Link: https://patchwork.freedesktop.org/patch/msgid/20241029133819.78696-2-pstanner@redhat.com
drivers/gpu/drm/scheduler/sched_main.c