protocol: clarify wl_display.delete_id description
authorManuel Stoeckl <code@mstoeckl.com>
Fri, 5 Jul 2019 23:42:16 +0000 (19:42 -0400)
committerManuel Stoeckl <code@mstoeckl.com>
Fri, 5 Jul 2019 23:42:24 +0000 (19:42 -0400)
libwayland-server only sends wl_display.delete_id events when
it responds to a client's destruction of a client-allocated
object. server-allocated objects are silently removed, as per
`wl_resource_destroy`.

Signed-off-by: Manuel Stoeckl <code@mstoeckl.com>
protocol/wayland.xml

index dee0ac1..d1b28be 100644 (file)
     <event name="delete_id">
       <description summary="acknowledge object ID deletion">
        This event is used internally by the object ID management
-       logic.  When a client deletes an object, the server will send
-       this event to acknowledge that it has seen the delete request.
-       When the client receives this event, it will know that it can
-       safely reuse the object ID.
+       logic. When a client deletes an object that it had created,
+       the server will send this event to acknowledge that it has
+       seen the delete request. When the client receives this event,
+       it will know that it can safely reuse the object ID.
       </description>
       <arg name="id" type="uint" summary="deleted object ID"/>
     </event>