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 <[email protected]>
Acked-by: Sam Ravnborg <[email protected]>
Reviewed-by: Simon Ser <[email protected]>
---
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(-)
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
--
2.25.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 <[email protected]>
> Acked-by: Sam Ravnborg <[email protected]>
> Reviewed-by: Simon Ser <[email protected]>
Thanks, documentation updates are always good.
Applied to drm-misc (drm-misc-next).
Sam