diff options
author | Kristian Høgsberg <krh@bitplanet.net> | 2014-02-19 10:24:46 -0800 |
---|---|---|
committer | Kristian Høgsberg <krh@bitplanet.net> | 2014-02-19 10:24:46 -0800 |
commit | 97b52203aac57dac1fc0c17ba5037e69991dcdac (patch) | |
tree | 24bca7136175629ad61a46672318ad58eb7d1819 /protocol | |
parent | c7680b09dd0c089f8e3894d65f999b430284a51c (diff) | |
download | weston-97b52203aac57dac1fc0c17ba5037e69991dcdac.tar.gz |
xdg-shell: Improve documentation for use_unstable_version request
Clarify that this is for catching protocol mismatch while the protocol
is under development.
Diffstat (limited to 'protocol')
-rw-r--r-- | protocol/xdg-shell.xml | 15 |
1 files changed, 9 insertions, 6 deletions
diff --git a/protocol/xdg-shell.xml b/protocol/xdg-shell.xml index 5d6f69ee..a2913c4c 100644 --- a/protocol/xdg-shell.xml +++ b/protocol/xdg-shell.xml @@ -40,8 +40,10 @@ <enum name="version"> <description summary="latest protocol version"> - 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. </description> <entry name="current" value="3" summary="Always the latest version"/> </enum> @@ -49,10 +51,11 @@ <request name="use_unstable_version"> <description summary="enable use of this unstable version"> - 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. </description> <arg name="version" type="int"/> </request> |