[wayland-protocols,v2] xdg-output: make xdg_output.description mutable

Submitted by Simon Ser on July 17, 2019, 8:25 a.m.

Details

Message ID 5RKmTWP5ivKA9NtU7DXql9isN6PTVhZ4u8Z7KU_q07uRPecILy-k6KaCApfYEEJGU7pinzZskPvdtc6evHmiljGURwunl3BQsWeepZ-CBjc=@emersion.fr
State Accepted
Headers show
Series "xdg-output: make xdg_output.description mutable" ( rev: 2 ) in Wayland

Not browsing as part of any series.

Commit Message

Simon Ser July 17, 2019, 8:25 a.m.
The output description is a human-readable text describing the output. Unlike
the name which uniquely identifies the output, it's intended to be displayed to
the user.

It might be desirable for a compositor to update an output's description. For
instance, when only one output is plugged in, it's not necessary to dump make,
model, serial and connector to the description, something like "Dell U2717D" is
enough. However when two identical outputs are plugged in it's necessary to add
e.g. the connector type to tell them apart ("Dell U2717D on HDMI"). See [1] for
a discussion about this.

This commit bumps xdg_output's version to allow compositors to update the
property.

[1]: https://github.com/swaywm/wlroots/issues/1623

Signed-off-by: Simon Ser <contact@emersion.fr>
---

The version isn't bumped because this has already been done in the previous
patch.

Changes in v2: rebased on top of HEAD

 unstable/xdg-output/xdg-output-unstable-v1.xml | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

--
2.22.0

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 9efb7a40417b..fe3a70aab0d2 100644
--- a/unstable/xdg-output/xdg-output-unstable-v1.xml
+++ b/unstable/xdg-output/xdg-output-unstable-v1.xml
@@ -206,10 +206,12 @@ 
 	output via :1'.

 	The description event is sent after creating an xdg_output (see
-	xdg_output_manager.get_xdg_output). This event is only sent once per
+	xdg_output_manager.get_xdg_output) and whenever the description
+	changes. The description is optional, and may not be sent at all.
+
+	For objects of version 2 and lower, this event is only sent once per
 	xdg_output, and the description does not change over the lifetime of
-	the wl_output global. The description is optional, and may not be sent
-	at all.
+	the wl_output global.
       </description>
       <arg name="description" type="string" summary="output description"/>
     </event>

Comments

On Wed, Jul 17, 2019 at 08:25:59AM +0000, Simon Ser wrote:
> The output description is a human-readable text describing the output. Unlike
> the name which uniquely identifies the output, it's intended to be displayed to
> the user.
> 
> It might be desirable for a compositor to update an output's description. For
> instance, when only one output is plugged in, it's not necessary to dump make,
> model, serial and connector to the description, something like "Dell U2717D" is
> enough. However when two identical outputs are plugged in it's necessary to add
> e.g. the connector type to tell them apart ("Dell U2717D on HDMI"). See [1] for
> a discussion about this.
> 
> This commit bumps xdg_output's version to allow compositors to update the
> property.
> 
> [1]: https://github.com/swaywm/wlroots/issues/1623
> 
> Signed-off-by: Simon Ser <contact@emersion.fr>

Thanks for the rebase.

Reviewed-by: Jonas Ådahl <jadahl@gmail.com>


Jonas

> ---
> 
> The version isn't bumped because this has already been done in the previous
> patch.
> 
> Changes in v2: rebased on top of HEAD
> 
>  unstable/xdg-output/xdg-output-unstable-v1.xml | 8 +++++---
>  1 file changed, 5 insertions(+), 3 deletions(-)
> 
> diff --git a/unstable/xdg-output/xdg-output-unstable-v1.xml b/unstable/xdg-output/xdg-output-unstable-v1.xml
> index 9efb7a40417b..fe3a70aab0d2 100644
> --- a/unstable/xdg-output/xdg-output-unstable-v1.xml
> +++ b/unstable/xdg-output/xdg-output-unstable-v1.xml
> @@ -206,10 +206,12 @@
>  	output via :1'.
> 
>  	The description event is sent after creating an xdg_output (see
> -	xdg_output_manager.get_xdg_output). This event is only sent once per
> +	xdg_output_manager.get_xdg_output) and whenever the description
> +	changes. The description is optional, and may not be sent at all.
> +
> +	For objects of version 2 and lower, this event is only sent once per
>  	xdg_output, and the description does not change over the lifetime of
> -	the wl_output global. The description is optional, and may not be sent
> -	at all.
> +	the wl_output global.
>        </description>
>        <arg name="description" type="string" summary="output description"/>
>      </event>
> --
> 2.22.0
> 
> 
> _______________________________________________
> wayland-devel mailing list
> wayland-devel@lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/wayland-devel
On Wed, Jul 17, 2019 at 08:25:59AM +0000, Simon Ser wrote:
> The output description is a human-readable text describing the output. Unlike
> the name which uniquely identifies the output, it's intended to be displayed to
> the user.
> 
> It might be desirable for a compositor to update an output's description. For
> instance, when only one output is plugged in, it's not necessary to dump make,
> model, serial and connector to the description, something like "Dell U2717D" is
> enough. However when two identical outputs are plugged in it's necessary to add
> e.g. the connector type to tell them apart ("Dell U2717D on HDMI"). See [1] for
> a discussion about this.
> 
> This commit bumps xdg_output's version to allow compositors to update the
> property.
> 
> [1]: https://github.com/swaywm/wlroots/issues/1623
> 
> Signed-off-by: Simon Ser <contact@emersion.fr>

Now pushed with my Reviewed-by and Oliviers Acked-by.


Jonas


> ---
> 
> The version isn't bumped because this has already been done in the previous
> patch.
> 
> Changes in v2: rebased on top of HEAD
> 
>  unstable/xdg-output/xdg-output-unstable-v1.xml | 8 +++++---
>  1 file changed, 5 insertions(+), 3 deletions(-)
> 
> diff --git a/unstable/xdg-output/xdg-output-unstable-v1.xml b/unstable/xdg-output/xdg-output-unstable-v1.xml
> index 9efb7a40417b..fe3a70aab0d2 100644
> --- a/unstable/xdg-output/xdg-output-unstable-v1.xml
> +++ b/unstable/xdg-output/xdg-output-unstable-v1.xml
> @@ -206,10 +206,12 @@
>  	output via :1'.
> 
>  	The description event is sent after creating an xdg_output (see
> -	xdg_output_manager.get_xdg_output). This event is only sent once per
> +	xdg_output_manager.get_xdg_output) and whenever the description
> +	changes. The description is optional, and may not be sent at all.
> +
> +	For objects of version 2 and lower, this event is only sent once per
>  	xdg_output, and the description does not change over the lifetime of
> -	the wl_output global. The description is optional, and may not be sent
> -	at all.
> +	the wl_output global.
>        </description>
>        <arg name="description" type="string" summary="output description"/>
>      </event>
> --
> 2.22.0
> 
> 
> _______________________________________________
> wayland-devel mailing list
> wayland-devel@lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/wayland-devel