diff --git a/doc/book/src/Message_XML.md b/doc/book/src/Message_XML.md index c44deee9..2a3c5f3f 100644 --- a/doc/book/src/Message_XML.md +++ b/doc/book/src/Message_XML.md @@ -140,7 +140,8 @@ usage of the interface. the interfaces part of the same interface ancestry tree. The exception to this rule are interfaces which are forever stuck to version 1, which is usually caused by having multiple parent interfaces with independent - ancestor global interfaces. + ancestor global interfaces. In this case, the `frozen="true"` attribute + described below should be used. A protocol object may have any defined version of the interface. The version of the object is determined at runtime either by inheritance from another @@ -152,6 +153,15 @@ usage of the interface. thoroughly updated as required. In such cases the object shall function as with the highest defined interface version. +**Optional attributes** + +`frozen`="`true`" + : The interface is frozen and forever stuck at version 1. + + This attribute should be applied to interfaces that have multiple parent + interfaces with independent ancestor global interfaces, for example + `wl_buffer` and `wl_callback`. + ### request Parent elements: interface diff --git a/protocol/wayland.dtd b/protocol/wayland.dtd index b97372c5..ae8340d6 100644 --- a/protocol/wayland.dtd +++ b/protocol/wayland.dtd @@ -4,6 +4,7 @@ + diff --git a/protocol/wayland.xml b/protocol/wayland.xml index 19f18479..513b8fd8 100644 --- a/protocol/wayland.xml +++ b/protocol/wayland.xml @@ -173,7 +173,7 @@ - + Clients can handle the 'done' event to get notified when the related request is done. @@ -503,7 +503,7 @@ - + A buffer provides the content for a wl_surface. Buffers are created through factory interfaces such as wl_shm, wp_linux_buffer_params