xdg-shell: Document responsibilities regarding ping events

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@gmail.com>

diff --git a/protocol/xdg-shell.xml b/protocol/xdg-shell.xml
index 06a6cfd6190f6e8f7c2cec71b5a45329e6f14295..72570363c4330228f3942d139f716d108d756d3a 100644 (file)
--- a/protocol/xdg-shell.xml
+++ b/protocol/xdg-shell.xml
@@ -123,6 +123,9 @@
         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 compositor is free to ping in any way it wants, but a client must
+        always respond to any xdg_shell object it created.
       </description>
       <arg name="serial" type="uint" summary="pass this to the pong request"/>
     </event>