Regenerate protocols with new xml specs

src/client/protocol.rs

@@ -3668,7 +3668,7 @@ pub mod linux_dmabuf_v1 {
             #[doc = "of planes and the format, bad format, non-positive width or"]
             #[doc = "height, or bad offset or stride."]
             #[doc = "- INVALID_WL_BUFFER, in case the cause for failure is unknown or"]
-            #[doc = "plaform specific."]
+            #[doc = "platform specific."]
             #[doc = "- the server creates an invalid wl_buffer, marks it as failed and"]
             #[doc = "sends a 'failed' event to the client. The result of using this"]
             #[doc = "invalid wl_buffer as an argument in any request by the client is"]
@@ -4743,8 +4743,7 @@ pub mod viewporter {
     #[doc = "src_y, src_width, src_height), and the destination size (dst_width,"]
     #[doc = "dst_height). The contents of the source rectangle are scaled to the"]
     #[doc = "destination size, and content outside the source rectangle is ignored."]
-    #[doc = "This state is double-buffered, and is applied on the next"]
-    #[doc = "wl_surface.commit."]
+    #[doc = "This state is double-buffered, see wl_surface.commit."]
     #[doc = ""]
     #[doc = "The two parts of crop and scale state are independent: the source"]
     #[doc = "rectangle, and the destination size. Initially both are unset, that"]
@@ -4852,8 +4851,7 @@ pub mod viewporter {
             #[doc = "or negative, or x or y are negative, raise the bad_value protocol"]
             #[doc = "error."]
             #[doc = ""]
-            #[doc = "The crop and scale state is double-buffered state, and will be"]
-            #[doc = "applied on the next wl_surface.commit."]
+            #[doc = "The crop and scale state is double-buffered, see wl_surface.commit."]
             async fn set_source(
                 &self,
                 socket: &mut crate::wire::Socket,
@@ -4884,8 +4882,7 @@ pub mod viewporter {
             #[doc = "contains zero or negative values raises the bad_value protocol"]
             #[doc = "error."]
             #[doc = ""]
-            #[doc = "The crop and scale state is double-buffered state, and will be"]
-            #[doc = "applied on the next wl_surface.commit."]
+            #[doc = "The crop and scale state is double-buffered, see wl_surface.commit."]
             async fn set_destination(
                 &self,
                 socket: &mut crate::wire::Socket,
@@ -5549,8 +5546,7 @@ pub mod xdg_shell {
             #[doc = "portions like drop-shadows which should be ignored for the"]
             #[doc = "purposes of aligning, placing and constraining windows."]
             #[doc = ""]
-            #[doc = "The window geometry is double buffered, and will be applied at the"]
-            #[doc = "time wl_surface.commit of the corresponding wl_surface is called."]
+            #[doc = "The window geometry is double-buffered state, see wl_surface.commit."]
             #[doc = ""]
             #[doc = "When maintaining a position, the compositor should treat the (x, y)"]
             #[doc = "coordinate of the window geometry as the top left corner of the window."]
@@ -5666,7 +5662,7 @@ pub mod xdg_shell {
     #[doc = "attributes (e.g. title, state, stacking, ...) are discarded for"]
     #[doc = "an xdg_toplevel surface when it is unmapped. The xdg_toplevel returns to"]
     #[doc = "the state it had right after xdg_surface.get_toplevel. The client"]
-    #[doc = "can re-map the toplevel by perfoming a commit without any buffer"]
+    #[doc = "can re-map the toplevel by performing a commit without any buffer"]
     #[doc = "attached, waiting for a configure event and handling it as usual (see"]
     #[doc = "xdg_surface description)."]
     #[doc = ""]
@@ -5734,8 +5730,7 @@ pub mod xdg_shell {
         #[doc = "configure event to ensure that both the client and the compositor"]
         #[doc = "setting the state can be synchronized."]
         #[doc = ""]
-        #[doc = "States set in this way are double-buffered. They will get applied on"]
-        #[doc = "the next commit."]
+        #[doc = "States set in this way are double-buffered, see wl_surface.commit."]
         #[repr(u32)]
         #[non_exhaustive]
         #[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Copy)]
@@ -6041,8 +6036,7 @@ pub mod xdg_shell {
             #[doc = "The width and height arguments are in window geometry coordinates."]
             #[doc = "See xdg_surface.set_window_geometry."]
             #[doc = ""]
-            #[doc = "Values set in this way are double-buffered. They will get applied"]
-            #[doc = "on the next commit."]
+            #[doc = "Values set in this way are double-buffered, see wl_surface.commit."]
             #[doc = ""]
             #[doc = "The compositor can use this information to allow or disallow"]
             #[doc = "different states like maximize or fullscreen and draw accurate"]
@@ -6092,8 +6086,7 @@ pub mod xdg_shell {
             #[doc = "The width and height arguments are in window geometry coordinates."]
             #[doc = "See xdg_surface.set_window_geometry."]
             #[doc = ""]
-            #[doc = "Values set in this way are double-buffered. They will get applied"]
-            #[doc = "on the next commit."]
+            #[doc = "Values set in this way are double-buffered, see wl_surface.commit."]
             #[doc = ""]
             #[doc = "The compositor can use this information to allow or disallow"]
             #[doc = "different states like maximize or fullscreen and draw accurate"]
@@ -7253,7 +7246,7 @@ pub mod drm_lease_v1 {
             }
             #[doc = "Submits the lease request and creates a new wp_drm_lease_v1 object."]
             #[doc = "After calling submit the compositor will immediately destroy this"]
-            #[doc = "object, issuing any more requests will cause a wl_diplay error."]
+            #[doc = "object, issuing any more requests will cause a wl_display error."]
             #[doc = "The compositor doesn't make any guarantees about the events of the"]
             #[doc = "lease object, clients cannot expect an immediate response."]
             #[doc = "Not requesting any connectors before submitting the lease request"]
@@ -8968,6 +8961,9 @@ pub mod tearing_control_v1 {
     #[doc = "presentation with tearing."]
     #[doc = "The default presentation hint is vsync. See presentation_hint for more"]
     #[doc = "details."]
+    #[doc = ""]
+    #[doc = "If the associated wl_surface is destroyed, this object becomes inert and"]
+    #[doc = "should be destroyed."]
     pub mod wp_tearing_control_v1 {
         use futures_util::SinkExt;
         #[doc = "This enum provides information for if submitted frames from the client"]
@@ -9002,7 +8998,7 @@ pub mod tearing_control_v1 {
                 }
             }
             #[doc = "Set the presentation hint for the associated wl_surface. This state is"]
-            #[doc = "double-buffered and is applied on the next wl_surface.commit."]
+            #[doc = "double-buffered, see wl_surface.commit."]
             #[doc = ""]
             #[doc = "The compositor is free to dynamically respect or ignore this hint based"]
             #[doc = "on various conditions like hardware capabilities, surface state and"]
@@ -9815,8 +9811,7 @@ pub mod xwayland_shell_v1 {
                 }
             }
             #[doc = "Associates an Xwayland window to a wl_surface."]
-            #[doc = "The association state is double-buffered and will be applied at"]
-            #[doc = "the time wl_surface.commit of the corresponding wl_surface is called."]
+            #[doc = "The association state is double-buffered, see wl_surface.commit."]
             #[doc = ""]
             #[doc = "The `serial_lo` and `serial_hi` parameters specify a non-zero"]
             #[doc = "monotonic serial number which is entirely unique and provided by the"]
@@ -11467,7 +11462,7 @@ pub mod linux_dmabuf_unstable_v1 {
             #[doc = "of planes and the format, bad format, non-positive width or"]
             #[doc = "height, or bad offset or stride."]
             #[doc = "- INVALID_WL_BUFFER, in case the cause for failure is unknown or"]
-            #[doc = "plaform specific."]
+            #[doc = "platform specific."]
             #[doc = "- the server creates an invalid wl_buffer, marks it as failed and"]
             #[doc = "sends a 'failed' event to the client. The result of using this"]
             #[doc = "invalid wl_buffer as an argument in any request by the client is"]
@@ -12130,9 +12125,8 @@ pub mod pointer_constraints_unstable_v1 {
             #[doc = "information to warp the pointer upon unlock in order to avoid pointer"]
             #[doc = "jumps."]
             #[doc = ""]
-            #[doc = "The cursor position hint is double buffered. The new hint will only take"]
-            #[doc = "effect when the associated surface gets it pending state applied. See"]
-            #[doc = "wl_surface.commit for details."]
+            #[doc = "The cursor position hint is double-buffered state, see"]
+            #[doc = "wl_surface.commit."]
             async fn set_cursor_position_hint(
                 &self,
                 socket: &mut crate::wire::Socket,
@@ -12155,9 +12149,7 @@ pub mod pointer_constraints_unstable_v1 {
             }
             #[doc = "Set a new region used to lock the pointer."]
             #[doc = ""]
-            #[doc = "The new lock region is double-buffered. The new lock region will"]
-            #[doc = "only take effect when the associated surface gets its pending state"]
-            #[doc = "applied. See wl_surface.commit for details."]
+            #[doc = "The new lock region is double-buffered, see wl_surface.commit."]
             #[doc = ""]
             #[doc = "For details about the lock region, see wp_locked_pointer."]
             async fn set_region(
@@ -12223,9 +12215,7 @@ pub mod pointer_constraints_unstable_v1 {
             }
             #[doc = "Set a new region used to confine the pointer."]
             #[doc = ""]
-            #[doc = "The new confine region is double-buffered. The new confine region will"]
-            #[doc = "only take effect when the associated surface gets its pending state"]
-            #[doc = "applied. See wl_surface.commit for details."]
+            #[doc = "The new confine region is double-buffered, see wl_surface.commit."]
             #[doc = ""]
             #[doc = "If the confinement is active when the new confinement region is applied"]
             #[doc = "and the pointer ends up outside of newly applied region, the pointer may"]
@@ -12261,7 +12251,7 @@ pub mod pointer_gestures_unstable_v1 {
     #[doc = ""]
     #[doc = "Three gestures are currently supported: swipe, pinch, and hold."]
     #[doc = "Pinch and swipe gestures follow a three-stage cycle: begin, update,"]
-    #[doc = "end, hold gestures follow a two-stage cycle: begin and end. All"]
+    #[doc = "end. Hold gestures follow a two-stage cycle: begin and end. All"]
     #[doc = "gestures are identified by a unique id."]
     #[doc = ""]
     #[doc = "Warning! The protocol described in this file is experimental and"]
@@ -16008,8 +15998,7 @@ pub mod xdg_shell_unstable_v5 {
         #[doc = "configure event to ensure that both the client and the compositor"]
         #[doc = "setting the state can be synchronized."]
         #[doc = ""]
-        #[doc = "States set in this way are double-buffered. They will get applied on"]
-        #[doc = "the next commit."]
+        #[doc = "States set in this way are double-buffered, see wl_surface.commit."]
         #[doc = ""]
         #[doc = "Desktop environments may extend this enum by taking up a range of"]
         #[doc = "values and documenting the range they chose in this description."]
@@ -16304,8 +16293,7 @@ pub mod xdg_shell_unstable_v5 {
             #[doc = "portions like drop-shadows which should be ignored for the"]
             #[doc = "purposes of aligning, placing and constraining windows."]
             #[doc = ""]
-            #[doc = "The window geometry is double buffered, and will be applied at the"]
-            #[doc = "time wl_surface.commit of the corresponding wl_surface is called."]
+            #[doc = "The window geometry is double-buffered state, see wl_surface.commit."]
             #[doc = ""]
             #[doc = "Once the window geometry of the surface is set once, it is not"]
             #[doc = "possible to unset it, and it will remain the same until"]
@@ -17061,8 +17049,7 @@ pub mod xdg_shell_unstable_v6 {
             #[doc = "portions like drop-shadows which should be ignored for the"]
             #[doc = "purposes of aligning, placing and constraining windows."]
             #[doc = ""]
-            #[doc = "The window geometry is double buffered, and will be applied at the"]
-            #[doc = "time wl_surface.commit of the corresponding wl_surface is called."]
+            #[doc = "The window geometry is double-buffered state, see wl_surface.commit."]
             #[doc = ""]
             #[doc = "Once the window geometry of the surface is set, it is not possible to"]
             #[doc = "unset it, and it will remain the same until set_window_geometry is"]
@@ -17183,8 +17170,7 @@ pub mod xdg_shell_unstable_v6 {
         #[doc = "configure event to ensure that both the client and the compositor"]
         #[doc = "setting the state can be synchronized."]
         #[doc = ""]
-        #[doc = "States set in this way are double-buffered. They will get applied on"]
-        #[doc = "the next commit."]
+        #[doc = "States set in this way are double-buffered, see wl_surface.commit."]
         #[repr(u32)]
         #[non_exhaustive]
         #[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Copy)]
@@ -17438,8 +17424,7 @@ pub mod xdg_shell_unstable_v6 {
             #[doc = "The width and height arguments are in window geometry coordinates."]
             #[doc = "See xdg_surface.set_window_geometry."]
             #[doc = ""]
-            #[doc = "Values set in this way are double-buffered. They will get applied"]
-            #[doc = "on the next commit."]
+            #[doc = "Values set in this way are double-buffered, see wl_surface.commit."]
             #[doc = ""]
             #[doc = "The compositor can use this information to allow or disallow"]
             #[doc = "different states like maximize or fullscreen and draw accurate"]
@@ -17489,8 +17474,7 @@ pub mod xdg_shell_unstable_v6 {
             #[doc = "The width and height arguments are in window geometry coordinates."]
             #[doc = "See xdg_surface.set_window_geometry."]
             #[doc = ""]
-            #[doc = "Values set in this way are double-buffered. They will get applied"]
-            #[doc = "on the next commit."]
+            #[doc = "Values set in this way are double-buffered, see wl_surface.commit."]
             #[doc = ""]
             #[doc = "The compositor can use this information to allow or disallow"]
             #[doc = "different states like maximize or fullscreen and draw accurate"]