drm/atomic: Make the drm_atomic_state documentation less ambiguous
authorMaxime Ripard <mripard@kernel.org>
Thu, 14 Dec 2023 10:09:15 +0000 (11:09 +0100)
committerMaxime Ripard <mripard@kernel.org>
Mon, 18 Dec 2023 10:45:34 +0000 (11:45 +0100)
commitab9fabeae4e71095d29216ff14f8a56e4fdda895
tree13c4c457e5e8e461e23c2eaebe0068ce26d6d6ea
parent17beda5e951aac35fee26703719c252bb216b56b
drm/atomic: Make the drm_atomic_state documentation less ambiguous

The current documentation of drm_atomic_state says that it's the "global
state object". This is confusing since, while it does contain all the
objects affected by an update and their respective states, if an object
isn't affected by this update it won't be part of it.

Thus, it's not truly a "global state", unlike object state structures
that do contain the entire state of a given object.

Reviewed-by: Hamza Mahfooz <hamza.mahfooz@amd.com>
Acked-by: Pekka Paalanen <pekka.paalanen@collabora.com>
Link: https://lore.kernel.org/r/20231214100917.277842-4-mripard@kernel.org
Signed-off-by: Maxime Ripard <mripard@kernel.org>
include/drm/drm_atomic.h