protocol: clarify wl_seat.name description
authorSimon Ser <contact@emersion.fr>
Tue, 29 Jun 2021 10:47:04 +0000 (12:47 +0200)
committerSimon Ser <contact@emersion.fr>
Tue, 6 Jul 2021 11:57:39 +0000 (11:57 +0000)
Define the expected properties of the seat name.

Signed-off-by: Simon Ser <contact@emersion.fr>
protocol/wayland.xml

index ef65714..a87e9dd 100644 (file)
 
     <event name="name" since="2">
       <description summary="unique identifier for this seat">
-       In a multiseat configuration this can be used by the client to help
-       identify which physical devices the seat represents. Based on
-       the seat configuration used by the compositor.
+       In a multi-seat configuration the seat name can be used by clients to
+       help identify which physical devices the seat represents.
+
+       The seat name is a UTF-8 string with no convention defined for its
+       contents. Each name is unique among all wl_seat globals. The name is
+       only guaranteed to be unique for the current compositor instance.
+
+       The same seat names are used for all clients. Thus, the name can be
+       shared across processes to refer to a specific wl_seat global.
+
+       The name event is sent after binding to the seat global. This event is
+       only sent once per seat object, and the name does not change over the
+       lifetime of the wl_seat global.
+
+       Compositors may re-use the same seat name if the wl_seat global is
+       destroyed and re-created later.
       </description>
       <arg name="name" type="string" summary="seat identifier"/>
     </event>