[PATCH] drm: Clarify DRM_MODE_REFLECT_X/Y documentation

[Daniel Vetter]

On Mon, Aug 20, 2018 at 10:10:52AM +0100, Alexandru-Cosmin Gheorghe wrote:
> On Tue, Aug 14, 2018 at 10:36:58AM +0200, Daniel Vetter wrote:
> > On Fri, Aug 10, 2018 at 06:50:31PM +0100, Alexandru Gheorghe wrote:
> > > DRM_MODE_REFLECT_X and DRM_MODE_REFLECT_Y meaning seems a bit unclear
> > > to me, so try to clarify that with a bit of ascii graphics.
> > > 
> > > Signed-off-by: Alexandru Gheorghe <alexandru-cosmin.gheorghe at arm.com>
> > > ---
> > >  include/uapi/drm/drm_mode.h | 11 ++++++++++-
> > >  1 file changed, 10 insertions(+), 1 deletion(-)
> > > 
> > > diff --git a/include/uapi/drm/drm_mode.h b/include/uapi/drm/drm_mode.h
> > > index 8d67243952f4..ac5de85c93eb 100644
> > > --- a/include/uapi/drm/drm_mode.h
> > > +++ b/include/uapi/drm/drm_mode.h
> > > @@ -186,9 +186,18 @@ extern "C" {
> > >  /*
> > >   * DRM_MODE_REFLECT_<axis>
> > >   *
> > > - * Signals that the contents of a drm plane is reflected in the <axis> axis,
> > > + * Signals that the contents of a drm plane is reflected along the <axis> axis,
> > >   * in the same way as mirroring.
> > >   *
> > > + * DRM_MODE_REFLECT_X
> > > + * |o |    | o|
> > > + * |  | -> |  |
> > > + * | v|    |v |
> > > + *
> > > + * DRM_MODE_REFLECT_Y
> > > + * |o |    | ^|
> > > + * |  | -> |  |
> > > + * | v|    |o |
> > 
> > I think the above won't render correctly in sphinx. I think you need some
> > fixed-block quoting. Please run
> > 
> > $ make htmldocs
> > 
> > and check the output. With that addressed:
> 
> One small problem here this file is not included in the htmldoc
> generation and no comment in here is marked to be included in html
> documentation.

Hah, I guess my review was sub-par. And with that I realized we have have
this prop fairly well documented already, but it's hidden in
drm_plane_create_rotation_property(). Plus linked from

https://dri.freedesktop.org/docs/drm/gpu/drm-kms.html#plane-composition-properties

Might be better to move everything there, and just leave a hint here?
-Daniel

> 
> > 
> > Reviewed-by: Daniel Vetter <daniel.vetter at ffwll.ch>
> > 
> > >   * This define is provided as a convenience, looking up the property id
> > >   * using the name->prop id lookup is the preferred method.
> > >   */
> > > -- 
> > > 2.18.0
> > > 
> > > _______________________________________________
> > > dri-devel mailing list
> > > dri-devel at lists.freedesktop.org
> > > https://lists.freedesktop.org/mailman/listinfo/dri-devel
> > 
> > -- 
> > Daniel Vetter
> > Software Engineer, Intel Corporation
> > http://blog.ffwll.ch
> 
> -- 
> Cheers,
> Alex G

-- 
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch