[PATCH weston] xdg-shell: Clarify ack_configure behaviour

[Jasper St. Pierre]

Reviewed-by: Jasper St. Pierre <jstpierre at mecheye.net>

On Tue, Sep 1, 2015 at 8:32 AM, Derek Foreman <derekf at osg.samsung.com> wrote:
> Right now many toolkits (toytoolkit, gtk+ and EFL) will send an
> ack_configure request immediately in response to a configure event,
> even if they're not immediately committing the surface at that time.
>
> This leads to a situation where multiple configures receive ack_configure
> before any commit happens.
>
> There's really no reason for that sequence of events to bother a compositor,
> so this just clarifies the language to make it ok.
>
> Signed-off-by: Derek Foreman <derekf at osg.samsung.com>
> ---
>  protocol/xdg-shell.xml | 12 ++++++++++--
>  1 file changed, 10 insertions(+), 2 deletions(-)
>
> diff --git a/protocol/xdg-shell.xml b/protocol/xdg-shell.xml
> index f98e760..1d37e36 100644
> --- a/protocol/xdg-shell.xml
> +++ b/protocol/xdg-shell.xml
> @@ -398,8 +398,8 @@
>        <description summary="ack a configure event">
>          When a configure event is received, if a client commits the
>          surface in response to the configure event, then the client
> -        must make a ack_configure request before the commit request,
> -        passing along the serial of the configure event.
> +        must make an ack_configure request sometime before the commit
> +        request, passing along the serial of the configure event.
>
>          For instance, the compositor might use this information to move
>          a surface to the top left only when the client has drawn itself
> @@ -407,6 +407,14 @@
>
>          If the client receives multiple configure events before it
>          can respond to one, it only has to ack the last configure event.
> +
> +        A client is not required to commit immediately after sending
> +        an ack_configure request - it may even ack_configure several times
> +        before its next surface commit.
> +
> +        The compositor expects that the most recently received
> +        ack_configure request at the time of a commit indicates which
> +        configure event the client is responding to.
>        </description>
>        <arg name="serial" type="uint" summary="the serial from the configure event"/>
>      </request>
> --
> 2.5.1
>
> _______________________________________________
> wayland-devel mailing list
> wayland-devel at lists.freedesktop.org
> http://lists.freedesktop.org/mailman/listinfo/wayland-devel



-- 
  Jasper