[PATCH] drm/fb: document dirty helper better

[Daniel Vetter]

Apparently little none fact that there's no need to hand-roll your own
anymore. Cc'ing a bunch of driver people who might want to know this
too.

Cc: Rob Clark <robdclark at gmail.com>
Cc: Sebastian Reichel <sebastian.reichel at collabora.com>
Cc: Tomi Valkeinen <tomi.valkeinen at ti.com>
Cc: Maarten Lankhorst <maarten.lankhorst at linux.intel.com>
Cc: Maxime Ripard <maxime.ripard at bootlin.com>
Cc: Sean Paul <sean at poorly.run>
Cc: Gerd Hoffmann <kraxel at redhat.com>
Cc: David Lechner <david at lechnology.com>
Cc: Noralf Trønnes <noralf at tronnes.org>
Cc: Hans de Goede <hdegoede at redhat.com>
Signed-off-by: Daniel Vetter <daniel.vetter at intel.com>
---
 include/drm/drm_framebuffer.h | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/include/drm/drm_framebuffer.h b/include/drm/drm_framebuffer.h
index c23016748e3f..c0e0256e3e98 100644
--- a/include/drm/drm_framebuffer.h
+++ b/include/drm/drm_framebuffer.h
@@ -87,6 +87,9 @@ struct drm_framebuffer_funcs {
 	 * for more information as all the semantics and arguments have a one to
 	 * one mapping on this function.
 	 *
+	 * Atomic drivers should use drm_atomic_helper_dirtyfb() to implement
+	 * this hook.
+	 *
 	 * RETURNS:
 	 *
 	 * 0 on success or a negative error code on failure.
-- 
2.20.1