From 97b52203aac57dac1fc0c17ba5037e69991dcdac Mon Sep 17 00:00:00 2001 From: =?utf8?q?Kristian=20H=C3=B8gsberg?= Date: Wed, 19 Feb 2014 10:24:46 -0800 Subject: [PATCH] xdg-shell: Improve documentation for use_unstable_version request Clarify that this is for catching protocol mismatch while the protocol is under development. --- protocol/xdg-shell.xml | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/protocol/xdg-shell.xml b/protocol/xdg-shell.xml index 5d6f69e..a2913c4 100644 --- a/protocol/xdg-shell.xml +++ b/protocol/xdg-shell.xml @@ -40,8 +40,10 @@ - Use this enum to check the protocol version, and it will be updated - automatically. + The 'current' member of this enum gives the version of the + protocol. Implementations can compare this to the version + they implement using static_assert to ensure the protocol and + implementation versions match. @@ -49,10 +51,11 @@ - Use this request in order to enable use of this interface. - - Understand and agree that one is using an unstable interface, - that will likely change in the future, breaking the API. + Negotiate the unstable version of the interface. This + mechanism is in place to ensure client and server agree on the + unstable versions of the protocol that they speak or exit + cleanly if they don't agree. This request will go away once + the xdg-shell protocol is stable. -- 2.7.4