xdg-shell: Improve documentation for use_unstable_version request

Clarify that this is for catching protocol mismatch while the protocol
is under development.
dev
Kristian Høgsberg 12 years ago
parent c7680b09dd
commit 97b52203aa
  1. 15
      protocol/xdg-shell.xml

@ -40,8 +40,10 @@
<enum name="version"> <enum name="version">
<description summary="latest protocol version"> <description summary="latest protocol version">
Use this enum to check the protocol version, and it will be updated The 'current' member of this enum gives the version of the
automatically. protocol. Implementations can compare this to the version
they implement using static_assert to ensure the protocol and
implementation versions match.
</description> </description>
<entry name="current" value="3" summary="Always the latest version"/> <entry name="current" value="3" summary="Always the latest version"/>
</enum> </enum>
@ -49,10 +51,11 @@
<request name="use_unstable_version"> <request name="use_unstable_version">
<description summary="enable use of this unstable version"> <description summary="enable use of this unstable version">
Use this request in order to enable use of this interface. Negotiate the unstable version of the interface. This
mechanism is in place to ensure client and server agree on the
Understand and agree that one is using an unstable interface, unstable versions of the protocol that they speak or exit
that will likely change in the future, breaking the API. cleanly if they don't agree. This request will go away once
the xdg-shell protocol is stable.
</description> </description>
<arg name="version" type="int"/> <arg name="version" type="int"/>
</request> </request>

Loading…
Cancel
Save