Commit 6de74523 authored by Geert Uytterhoeven's avatar Geert Uytterhoeven Committed by Sam Ravnborg
Browse files

drm/fb: Improve drm_framebuffer.offsets documentation 



Fix various spelling and grammar mistakes in the kerneldoc comments
documenting the offsets member in the drm_framebuffer structure:
  - s/laytou/layout/,
  - Add missing "is",
  - s/it/its/.

Signed-off-by: default avatarGeert Uytterhoeven <geert@linux-m68k.org>
Acked-by: default avatarSam Ravnborg <sam@ravnborg.org>
Reviewed-by: default avatarSimon Ser <contact@emersion.fr>
Signed-off-by: default avatarSam Ravnborg <sam@ravnborg.org>
Link: https://patchwork.freedesktop.org/patch/msgid/33fda13b500b39645e7363806c6e458e915b581e.1657113304.git.geert@linux-m68k.org
parent a6aa679a

include/drm/drm_framebuffer.h

+4 −4
Original line number Diff line number Diff line
@@ -154,10 +154,10 @@ struct drm_framebuffer { 
	 * drm_mode_fb_cmd2.

	 *

	 * Note that this is a linear offset and does not take into account

	 * tiling or buffer laytou per @modifier. It meant to be used when the

	 * actual pixel data for this framebuffer plane starts at an offset,

	 * tiling or buffer layout per @modifier. It is meant to be used when

	 * the actual pixel data for this framebuffer plane starts at an offset,

	 * e.g. when multiple planes are allocated within the same backing

	 * storage buffer object. For tiled layouts this generally means it

	 * storage buffer object. For tiled layouts this generally means its

	 * @offsets must at least be tile-size aligned, but hardware often has

	 * stricter requirements.

	 *