[PATCH] drm/mode: Improve drm_mode_fb_cmd2 documentation

[PATCH] drm/mode: Improve drm_mode_fb_cmd2 documentation

[Geert Uytterhoeven]

Fix various grammar mistakes in the kerneldoc comments documenting the
drm_mode_fb_cmd2 structure:
  - s/is/are/,
  - s/8 bit/8-bit/.

Signed-off-by: Geert Uytterhoeven <geert@linux-m68k.org>
---
 include/uapi/drm/drm_mode.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/include/uapi/drm/drm_mode.h b/include/uapi/drm/drm_mode.h
index e1e351682872ebb3..5cea483c7be7a29e 100644
--- a/include/uapi/drm/drm_mode.h
+++ b/include/uapi/drm/drm_mode.h
@@ -673,12 +673,12 @@ struct drm_mode_fb_cmd2 {
 	/*
 	 * In case of planar formats, this ioctl allows up to 4
 	 * buffer objects with offsets and pitches per plane.
-	 * The pitch and offset order is dictated by the fourcc,
+	 * The pitch and offset order are dictated by the fourcc,
 	 * e.g. NV12 (https://fourcc.org/yuv.php#NV12) is described as:
 	 *
-	 *   YUV 4:2:0 image with a plane of 8 bit Y samples
+	 *   YUV 4:2:0 image with a plane of 8-bit Y samples
 	 *   followed by an interleaved U/V plane containing
-	 *   8 bit 2x2 subsampled colour difference samples.
+	 *   8-bit 2x2 subsampled colour difference samples.
 	 *
 	 * So it would consist of Y as offsets[0] and UV as
 	 * offsets[1].  Note that offsets[0] will generally
-- 
2.25.1

Re: [PATCH] drm/mode: Improve drm_mode_fb_cmd2 documentation

[Sam Ravnborg]

On Wed, Feb 16, 2022 at 09:41:36AM +0100, Geert Uytterhoeven wrote:
> Fix various grammar mistakes in the kerneldoc comments documenting the
> drm_mode_fb_cmd2 structure:
>   - s/is/are/,
>   - s/8 bit/8-bit/.
> 
> Signed-off-by: Geert Uytterhoeven <geert@linux-m68k.org>
Acked-by: Sam Ravnborg <sam@ravnborg.org>

Re: [PATCH] drm/mode: Improve drm_mode_fb_cmd2 documentation

[Simon Ser]

drm-misc-next has changed this doc comment. Can you rebase your changes?

Any any case, r-b me.

[1]: https://cgit.freedesktop.org/drm/drm-misc/commit/?id=a3574119826d9a4ef807fb973cf5150c3b90da43

[PATCH] drm/mode: Improve drm_mode_fb_cmd2 documentation

[Geert Uytterhoeven]

Fix various grammar mistakes in the kerneldoc comments documenting the
drm_mode_fb_cmd2 structure:
  - s/is/are/,
  - s/8 bit/8-bit/.

Signed-off-by: Geert Uytterhoeven <geert@linux-m68k.org>
---
 include/uapi/drm/drm_mode.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/include/uapi/drm/drm_mode.h b/include/uapi/drm/drm_mode.h
index e1e351682872ebb3..5cea483c7be7a29e 100644
--- a/include/uapi/drm/drm_mode.h
+++ b/include/uapi/drm/drm_mode.h
@@ -673,12 +673,12 @@ struct drm_mode_fb_cmd2 {
 	/*
 	 * In case of planar formats, this ioctl allows up to 4
 	 * buffer objects with offsets and pitches per plane.
-	 * The pitch and offset order is dictated by the fourcc,
+	 * The pitch and offset order are dictated by the fourcc,
 	 * e.g. NV12 (https://fourcc.org/yuv.php#NV12) is described as:
 	 *
-	 *   YUV 4:2:0 image with a plane of 8 bit Y samples
+	 *   YUV 4:2:0 image with a plane of 8-bit Y samples
 	 *   followed by an interleaved U/V plane containing
-	 *   8 bit 2x2 subsampled colour difference samples.
+	 *   8-bit 2x2 subsampled colour difference samples.
 	 *
 	 * So it would consist of Y as offsets[0] and UV as
 	 * offsets[1].  Note that offsets[0] will generally
-- 
2.25.1