[PATCH weston 05/17] xdg-shell: Document responsibilities regarding ping events

[Jonas Ådahl]

Document that a compositor is free to ping in any way it wants, but a
client must always respond to any xdg_shell object it created.

Signed-off-by: Jonas Ådahl <jadahl at gmail.com>
---
 protocol/xdg-shell.xml | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/protocol/xdg-shell.xml b/protocol/xdg-shell.xml
index 866bd85..0b6c999 100644
--- a/protocol/xdg-shell.xml
+++ b/protocol/xdg-shell.xml
@@ -124,6 +124,10 @@
         alive. It's unspecified what will happen if the client doesn't
         respond to the ping request, or in what timeframe. Clients should
         try to respond in a reasonable amount of time.
+
+        A client must be ready to respond to any bound xdg_shell objects ping
+        event. It is up to the compositor to decide when and to what xdg_shell
+        objects to ping.
       </description>
       <arg name="serial" type="uint" summary="pass this to the pong request"/>
     </event>
-- 
2.1.4