From 67f367f329f3640d12db43cf5dc14e7f8b1e1242 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Kristian=20H=C3=B8gsberg?= <krh@bitplanet.net>
Date: Thu, 9 Dec 2010 11:06:46 -0500
Subject: [PATCH] Document the shell.configure event a bit

---
 protocol/wayland.xml | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/protocol/wayland.xml b/protocol/wayland.xml
index ca887a90..62d8a663 100644
--- a/protocol/wayland.xml
+++ b/protocol/wayland.xml
@@ -164,6 +164,12 @@
       <arg name="id" type="new_id" interface="drag"/>
     </request>
 
+    <!-- The configure event asks the client to resize its surface.
+         The size is a hint, in the sense that the client is free to
+         ignore it if it doesn't resize, pick a smaller size (to
+         satisfy aspect ration or resize in steps of NxM pixels).  The
+         client is free to dismiss all but the last configure event it
+         received. -->
     <event name="configure">
       <arg name="time" type="uint"/>
       <!-- Same as edges except also move (16) -->