[v2] drm/fb: Improve drm_framebuffer.offsets documentation

Commit Message

Geert Uytterhoeven July 6, 2022, 1:16 p.m. UTC

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: Geert Uytterhoeven <[e-mail]>
Acked-by: Sam Ravnborg <[e-mail]>
Reviewed-by: Simon Ser <[e-mail]>
---
v2:
  - Add Acked-by, Reviewed-by.
---
 include/drm/drm_framebuffer.h | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

Comments

Sam Ravnborg July 9, 2022, 1:59 p.m. UTC | #1

Hi Geert,

On Wed, Jul 06, 2022 at 03:16:18PM +0200, Geert Uytterhoeven wrote:
> 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: Geert Uytterhoeven <[e-mail]>
> Acked-by: Sam Ravnborg <[e-mail]>
> Reviewed-by: Simon Ser <[e-mail]>
More doc improvements - good!
Applied to drm-misc (drm-misc-next).

	Sam

Patch

diff --git a/include/drm/drm_framebuffer.h b/include/drm/drm_framebuffer.h
index f67c5b7bcb68654a..0dcc07b68654844b 100644
--- a/include/drm/drm_framebuffer.h
+++ b/include/drm/drm_framebuffer.h
@@ -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,
-	 * e.g.  when multiple planes are allocated within the same backing
-	 * storage buffer object. For tiled layouts this generally means it
+	 * 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 its
 	 * @offsets must at least be tile-size aligned, but hardware often has
 	 * stricter requirements.
 	 *