[wayland-protocols] xdg-output: Clarify that output positions refer to the top-left corner

Submitted by William Wold on May 10, 2019, 4:53 p.m.

Details

Message ID CAOnGdFY6qHE+yDwrTXo09j491mhinWVVc4TjcRQ0gmgVn8xXSQ@mail.gmail.com
State Changes Requested
Headers show
Series "xdg-output: Clarify that output positions refer to the top-left corner" ( rev: 1 ) in Wayland

Not browsing as part of any series.

Commit Message

William Wold May 10, 2019, 4:53 p.m.
I already sent this two weeks ago, but I didn't get the subject right
and I didn't get any response. Hopefully this will work better. I
believe this is just clarifying what the protocol already meant (but I
can't be sure, on account of it not currently being clear).
---
 unstable/xdg-output/xdg-output-unstable-v1.xml | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

     </event>

     <event name="logical_size">
--
2.20.1

Patch hide | download patch | download mbox

diff --git a/unstable/xdg-output/xdg-output-unstable-v1.xml
b/unstable/xdg-output/xdg-output-unstable-v1.xml
index ccbfe1c..3176520 100644
--- a/unstable/xdg-output/xdg-output-unstable-v1.xml
+++ b/unstable/xdg-output/xdg-output-unstable-v1.xml
@@ -94,17 +94,17 @@ 

     <event name="logical_position">
       <description summary="position of the output within the global
compositor space">
-       The position event describes the location of the wl_output within
-       the global compositor space.
+       The position event describes the location of the top-left corner
+       of the wl_output within the global compositor space.

        The logical_position event is sent after creating an xdg_output
        (see xdg_output_manager.get_xdg_output) and whenever the location
        of the output changes within the global compositor space.
       </description>
       <arg name="x" type="int"
-          summary="x position within the global compositor space"/>
+          summary="x position of the output's left edge within the
global compositor space"/>
       <arg name="y" type="int"
-          summary="y position within the global compositor space"/>
+          summary="y position of the output's top edge within the
global compositor space"/>

Comments

Hi,

On Fri, May 10, 2019 at 6:53 PM William Wold <william.wold@canonical.com> wrote:
>
> I already sent this two weeks ago, but I didn't get the subject right
> and I didn't get any response. Hopefully this will work better. I

Yeap, sorry I missed it :/

> believe this is just clarifying what the protocol already meant (but I
> can't be sure, on account of it not currently being clear).

Yes, that's what was assumed, although wl_output::geometry event
doesn't specify this either:

https://wayland.freedesktop.org/docs/html/apa.html#protocol-spec-wl_output

> ---
>  unstable/xdg-output/xdg-output-unstable-v1.xml | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/unstable/xdg-output/xdg-output-unstable-v1.xml
> b/unstable/xdg-output/xdg-output-unstable-v1.xml
> index ccbfe1c..3176520 100644
> --- a/unstable/xdg-output/xdg-output-unstable-v1.xml
> +++ b/unstable/xdg-output/xdg-output-unstable-v1.xml
> @@ -94,17 +94,17 @@
>
>      <event name="logical_position">
>        <description summary="position of the output within the global
> compositor space">
> -       The position event describes the location of the wl_output within
> -       the global compositor space.
> +       The position event describes the location of the top-left corner
> +       of the wl_output within the global compositor space.
>
>         The logical_position event is sent after creating an xdg_output
>         (see xdg_output_manager.get_xdg_output) and whenever the location
>         of the output changes within the global compositor space.
>        </description>
>        <arg name="x" type="int"
> -          summary="x position within the global compositor space"/>
> +          summary="x position of the output's left edge within the
> global compositor space"/>
>        <arg name="y" type="int"
> -          summary="y position within the global compositor space"/>
> +          summary="y position of the output's top edge within the
> global compositor space"/>
>      </event>
>
>      <event name="logical_size">
> --
> 2.20.1

LGTM.

Reviewed-by: Olivier Fourdan <ofourdan@redhat.com>

Cheers

Olivier
Looks good. Could you write a similar patch for wayland core?

However it's missing a S-o-b line. Also please put the timely
commentary after the "---" separator so that it doesn't appear in the
commit message.