Commit 0c05fcd3 authored by Geert Uytterhoeven's avatar Geert Uytterhoeven Committed by Sam Ravnborg
Browse files

drm/mode: Improve drm_mode_fb_cmd2 documentation 



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: default avatarGeert Uytterhoeven <geert@linux-m68k.org>
Acked-by: default avatarSam Ravnborg <sam@ravnborg.org>
Reviewed-by: default avatarSimon Ser <contact@emersion.fr>
Signed-off-by: default avatarSam Ravnborg <sam@ravnborg.org>
Link: https://patchwork.freedesktop.org/patch/msgid/536de72eab09242e1faf22fa58d91c9005d6ea51.1657113597.git.geert@linux-m68k.org
Link: https://patchwork.freedesktop.org/patch/msgid/20220608020614.4098292-1-bjorn.andersson@linaro.org
parent b92db7e4

include/uapi/drm/drm_mode.h

+4 −4
Original line number Diff line number Diff line
@@ -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