drm/atomic-helper: Make zpos property kerneldoc less misleading
authorThierry Reding <treding@nvidia.com>
Mon, 20 Nov 2017 15:09:59 +0000 (16:09 +0100)
committerThierry Reding <treding@nvidia.com>
Thu, 14 Dec 2017 13:20:35 +0000 (14:20 +0100)
commitca40cfc85e548424e39dc3aebe61873535ddf7b6
tree4a2f09712171ff64997d0357a99402d11c5ce54c
parent170178fe99dd212bf25e70c89bc4b6e195564ffc
drm/atomic-helper: Make zpos property kerneldoc less misleading

kerneldoc for drm_plane_create_zpos_property() says that the DRM core
will automatically calculate the normalized zpos values, but it doesn't
actually do that anymore since commit 38d868e41c4b ("drm: Don't force
all planes to be added to the state due to zpos"). Instead, drivers are
supposed to explicitly call the drm_atomic_normalize_zpos() function.
Change the kerneldoc comment to reflect that.

v2: reference the commit that introduced the kerneldoc unclarity

Reviewed-by: Daniel Vetter <daniel.vetter@ffwll.ch>
Signed-off-by: Thierry Reding <treding@nvidia.com>
Link: https://patchwork.freedesktop.org/patch/msgid/20171120150959.26913-1-thierry.reding@gmail.com
drivers/gpu/drm/drm_blend.c