protocol: clarify multiple wl_surface.attach

Explicitly say what happens with the wl_buffer.release event, if you
attach several wl_buffers without a commit in between.

Reported-by: David Herrmann <dh.herrmann@googlemail.com>
Signed-off-by: Pekka Paalanen <ppaalanen@gmail.com>

diff --git a/protocol/wayland.xml b/protocol/wayland.xml
index 275ea28..07fee80 100644 (file)
--- a/protocol/wayland.xml
+++ b/protocol/wayland.xml
@@ -678,7 +678,9 @@
        time after the wl_surface.commit request. When the compositor will
        not access the pixels anymore, it will send the wl_buffer.release
        event. Only after receiving wl_buffer.release, the client may re-use
-       the wl_buffer.
+       the wl_buffer. A wl_buffer, that has been attached and then replaced
+       by another attach instead of committed, will not receive a release
+       event, and is not used by the compositor.
 
        Destroying the wl_buffer after wl_buffer.release does not change the
        surface contents, even if the wl_buffer is still pending for the