[PATCH 1/3] drm: reference mode flags in DRM_CLIENT_CAP_* docs

[PATCH 1/3] drm: reference mode flags in DRM_CLIENT_CAP_* docs

[Simon Ser]

In the docs for DRM_CLIENT_CAP_STEREO_3D and
DRM_CLIENT_CAP_ASPECT_RATIO, reference the DRM_MODE_FLAG_* defines
that get set when the cap is enabled.

Signed-off-by: Simon Ser <contact@emersion.fr>
Cc: Daniel Vetter <daniel@ffwll.ch>
Cc: Daniel Stone <daniels@collabora.com>
Cc: Pekka Paalanen <ppaalanen@gmail.com>
---
 include/uapi/drm/drm.h | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/include/uapi/drm/drm.h b/include/uapi/drm/drm.h
index 67b94bc3c885..1c947227f72b 100644
--- a/include/uapi/drm/drm.h
+++ b/include/uapi/drm/drm.h
@@ -777,9 +777,9 @@ struct drm_get_cap {
 /**
  * DRM_CLIENT_CAP_STEREO_3D
  *
- * if set to 1, the DRM core will expose the stereo 3D capabilities of the
+ * If set to 1, the DRM core will expose the stereo 3D capabilities of the
  * monitor by advertising the supported 3D layouts in the flags of struct
- * drm_mode_modeinfo.
+ * drm_mode_modeinfo. See ``DRM_MODE_FLAG_3D_*``.
  */
 #define DRM_CLIENT_CAP_STEREO_3D	1
 
@@ -804,6 +804,7 @@ struct drm_get_cap {
  * DRM_CLIENT_CAP_ASPECT_RATIO
  *
  * If set to 1, the DRM core will provide aspect ratio information in modes.
+ * See ``DRM_MODE_FLAG_PIC_AR_*``.
  */
 #define DRM_CLIENT_CAP_ASPECT_RATIO    4
 
-- 
2.31.1

Re: [PATCH 1/3] drm: reference mode flags in DRM_CLIENT_CAP_* docs

[Pekka Paalanen]

[-- Attachment #1: Type: text/plain, Size: 1497 bytes --]

On Tue, 18 May 2021 11:14:42 +0000
Simon Ser <contact@emersion.fr> wrote:

> In the docs for DRM_CLIENT_CAP_STEREO_3D and
> DRM_CLIENT_CAP_ASPECT_RATIO, reference the DRM_MODE_FLAG_* defines
> that get set when the cap is enabled.
> 
> Signed-off-by: Simon Ser <contact@emersion.fr>
> Cc: Daniel Vetter <daniel@ffwll.ch>
> Cc: Daniel Stone <daniels@collabora.com>
> Cc: Pekka Paalanen <ppaalanen@gmail.com>
> ---
>  include/uapi/drm/drm.h | 5 +++--
>  1 file changed, 3 insertions(+), 2 deletions(-)
> 
> diff --git a/include/uapi/drm/drm.h b/include/uapi/drm/drm.h
> index 67b94bc3c885..1c947227f72b 100644
> --- a/include/uapi/drm/drm.h
> +++ b/include/uapi/drm/drm.h
> @@ -777,9 +777,9 @@ struct drm_get_cap {
>  /**
>   * DRM_CLIENT_CAP_STEREO_3D
>   *
> - * if set to 1, the DRM core will expose the stereo 3D capabilities of the
> + * If set to 1, the DRM core will expose the stereo 3D capabilities of the
>   * monitor by advertising the supported 3D layouts in the flags of struct
> - * drm_mode_modeinfo.
> + * drm_mode_modeinfo. See ``DRM_MODE_FLAG_3D_*``.
>   */
>  #define DRM_CLIENT_CAP_STEREO_3D	1
>  
> @@ -804,6 +804,7 @@ struct drm_get_cap {
>   * DRM_CLIENT_CAP_ASPECT_RATIO
>   *
>   * If set to 1, the DRM core will provide aspect ratio information in modes.
> + * See ``DRM_MODE_FLAG_PIC_AR_*``.
>   */
>  #define DRM_CLIENT_CAP_ASPECT_RATIO    4
>  

Good.

Acked-by: Pekka Paalanen <pekka.paalanen@collabora.com>


Thanks,
pq

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 833 bytes --]