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

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

[Geert Uytterhoeven]

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 <geert@linux-m68k.org>
---
 include/drm/drm_framebuffer.h | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

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.
 	 *
-- 
2.25.1

Re: [PATCH] drm/fb: Improve drm_framebuffer.offsets documentation

[Sam Ravnborg]

Hi Geert,

On Wed, Feb 16, 2022 at 09:41:06AM +0100, 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 <geert@linux-m68k.org>
Acked-by: Sam Ravnborg <sam@ravnborg.org>


It would be great if you could get drm-misc commiter rights, then you
can push this and all your other nice patches yourself.
Especially since you are soon becoming a drm driver maintainer

	Sam

Re: [PATCH] drm/fb: Improve drm_framebuffer.offsets documentation

[Simon Ser]

Reviewed-by: Simon Ser <contact@emersion.fr>