* [PATCH] drm: Clarify DRM_MODE_REFLECT_X/Y documentation
@ 2018-08-10 17:50 Alexandru Gheorghe
2018-08-10 18:13 ` Sean Paul
2018-08-14 8:36 ` Daniel Vetter
0 siblings, 2 replies; 6+ messages in thread
From: Alexandru Gheorghe @ 2018-08-10 17:50 UTC (permalink / raw)
To: seanpaul, airlied, dri-devel, maarten.lankhorst, gustavo
Cc: nd, Alexandru Gheorghe
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@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 |
* 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@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel
^ permalink raw reply related [flat|nested] 6+ messages in thread
* Re: [PATCH] drm: Clarify DRM_MODE_REFLECT_X/Y documentation
2018-08-10 17:50 [PATCH] drm: Clarify DRM_MODE_REFLECT_X/Y documentation Alexandru Gheorghe
@ 2018-08-10 18:13 ` Sean Paul
2018-08-14 8:36 ` Daniel Vetter
1 sibling, 0 replies; 6+ messages in thread
From: Sean Paul @ 2018-08-10 18:13 UTC (permalink / raw)
To: Alexandru Gheorghe; +Cc: airlied, dri-devel, nd
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@arm.com>
Reviewed-by: Sean Paul <seanpaul@chromium.org>
> ---
> 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 |
> * 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
>
--
Sean Paul, Software Engineer, Google / Chromium OS
_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] drm: Clarify DRM_MODE_REFLECT_X/Y documentation
2018-08-10 17:50 [PATCH] drm: Clarify DRM_MODE_REFLECT_X/Y documentation Alexandru Gheorghe
2018-08-10 18:13 ` Sean Paul
@ 2018-08-14 8:36 ` Daniel Vetter
2018-08-20 9:10 ` Alexandru-Cosmin Gheorghe
1 sibling, 1 reply; 6+ messages in thread
From: Daniel Vetter @ 2018-08-14 8:36 UTC (permalink / raw)
To: Alexandru Gheorghe; +Cc: airlied, dri-devel, nd
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@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:
Reviewed-by: Daniel Vetter <daniel.vetter@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@lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/dri-devel
--
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch
_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] drm: Clarify DRM_MODE_REFLECT_X/Y documentation
2018-08-14 8:36 ` Daniel Vetter
@ 2018-08-20 9:10 ` Alexandru-Cosmin Gheorghe
2018-08-21 8:54 ` Daniel Vetter
0 siblings, 1 reply; 6+ messages in thread
From: Alexandru-Cosmin Gheorghe @ 2018-08-20 9:10 UTC (permalink / raw)
To: Daniel Vetter; +Cc: airlied, dri-devel, seanpaul, nd
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@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.
>
> Reviewed-by: Daniel Vetter <daniel.vetter@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@lists.freedesktop.org
> > https://lists.freedesktop.org/mailman/listinfo/dri-devel
>
> --
> Daniel Vetter
> Software Engineer, Intel Corporation
> http://blog.ffwll.ch
--
Cheers,
Alex G
_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] drm: Clarify DRM_MODE_REFLECT_X/Y documentation
2018-08-20 9:10 ` Alexandru-Cosmin Gheorghe
@ 2018-08-21 8:54 ` Daniel Vetter
2018-08-21 9:20 ` Alexandru-Cosmin Gheorghe
0 siblings, 1 reply; 6+ messages in thread
From: Daniel Vetter @ 2018-08-21 8:54 UTC (permalink / raw)
To: Alexandru-Cosmin Gheorghe; +Cc: airlied, dri-devel, seanpaul, nd
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@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@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@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
_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] drm: Clarify DRM_MODE_REFLECT_X/Y documentation
2018-08-21 8:54 ` Daniel Vetter
@ 2018-08-21 9:20 ` Alexandru-Cosmin Gheorghe
0 siblings, 0 replies; 6+ messages in thread
From: Alexandru-Cosmin Gheorghe @ 2018-08-21 9:20 UTC (permalink / raw)
To: Daniel Vetter; +Cc: airlied, dri-devel, seanpaul, nd
Hi,
On Tue, Aug 21, 2018 at 10:54:52AM +0200, Daniel Vetter wrote:
> 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@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?
I agree, it makes perfectly sense to move it to
drm_plane_create_rotation_property and just point to that here.
I will do that in v2.
> -Daniel
>
> >
> > >
> > > Reviewed-by: Daniel Vetter <daniel.vetter@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@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
--
Cheers,
Alex G
_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2018-08-21 9:20 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2018-08-10 17:50 [PATCH] drm: Clarify DRM_MODE_REFLECT_X/Y documentation Alexandru Gheorghe
2018-08-10 18:13 ` Sean Paul
2018-08-14 8:36 ` Daniel Vetter
2018-08-20 9:10 ` Alexandru-Cosmin Gheorghe
2018-08-21 8:54 ` Daniel Vetter
2018-08-21 9:20 ` Alexandru-Cosmin Gheorghe
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).