[v3] drm/mode: Improve drm_mode_fb_cmd2 documentation

Commit Message

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

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 <[e-mail]>
Acked-by: Sam Ravnborg <[e-mail]>
Reviewed-by: Simon Ser <[e-mail]>
---
v3:
  - Add Reviewed-by.

v2:
  - Add Acked-by,
  - Rebase on top of commit a3574119826d9a4e ("drm: document struct
    drm_mode_fb_cmd2") in v5.18.
---
 include/uapi/drm/drm_mode.h | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

Comments

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

Hi Geert,

On Wed, Jul 06, 2022 at 03:20:18PM +0200, 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 <[e-mail]>
> Acked-by: Sam Ravnborg <[e-mail]>
> Reviewed-by: Simon Ser <[e-mail]>

Thanks, documentation updates are always good.
Applied to drm-misc (drm-misc-next).


	Sam

Patch

diff --git a/include/uapi/drm/drm_mode.h b/include/uapi/drm/drm_mode.h
index 0a0d56a6158e6327..fa953309d9ce5775 100644
--- a/include/uapi/drm/drm_mode.h
+++ b/include/uapi/drm/drm_mode.h
@@ -675,11 +675,11 @@  struct drm_mode_fb_cmd {
  *   fetch metadata about an existing frame-buffer.
  *
  * In case of planar formats, this struct allows up to 4 buffer objects with
- * offsets and pitches per plane. The pitch and offset order is dictated by the
- * format FourCC as defined by ``drm_fourcc.h``, e.g. NV12 is described as:
+ * offsets and pitches per plane. The pitch and offset order are dictated by
+ * the format FourCC as defined by ``drm_fourcc.h``, e.g. NV12 is described as:
  *
- *     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
+ *     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.
  *
  * So it would consist of a Y plane at ``offsets[0]`` and a UV plane at