From 208fc99e66677fed61ba97382025f95db737696a Mon Sep 17 00:00:00 2001
From: Nick Diego Yamane <nickdiego@igalia.com>
Date: Wed, 28 Apr 2021 11:34:05 -0400
Subject: [PATCH] Document serial param usage in wl_pointer.set_cursor

Serial is supposed to contain the latest wl_pointer.enter value received
by clients but it was not even mentioned in the docs, so add it to avoid
misinterpretations.

Signed-off-by: Nick Diego Yamane <nickdiego@igalia.com>
---
 protocol/wayland.xml | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/protocol/wayland.xml b/protocol/wayland.xml
index 61e0366d..9955d247 100644
--- a/protocol/wayland.xml
+++ b/protocol/wayland.xml
@@ -1905,6 +1905,10 @@
 	wl_surface is no longer used as the cursor. When the use as a
 	cursor ends, the current and pending input regions become
 	undefined, and the wl_surface is unmapped.
+
+	The serial parameter must match the latest wl_pointer.enter
+	serial number sent to the client. Otherwise the request will be
+	ignored.
       </description>
       <arg name="serial" type="uint" summary="serial number of the enter event"/>
       <arg name="surface" type="object" interface="wl_surface" allow-null="true"