From 38f91fe6adb1c4e6347dc34111e17514dac4a439 Mon Sep 17 00:00:00 2001
From: Simon Ser <contact@emersion.fr>
Date: Thu, 19 Oct 2023 16:34:26 +0200
Subject: [PATCH] protocol: document that wl_surface.offset is role-specific

This request doesn't make sense for all surface roles. For instance,
for maximized/tiled/fullscreen xdg_toplevel, for xdg_popup, for
layer-shell surfaces, etc.

Signed-off-by: Simon Ser <contact@emersion.fr>
---
 protocol/wayland.xml | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/protocol/wayland.xml b/protocol/wayland.xml
index e0a67380..cd089e1b 100644
--- a/protocol/wayland.xml
+++ b/protocol/wayland.xml
@@ -1832,6 +1832,9 @@
 	x and y, combined with the new surface size define in which
 	directions the surface's size changes.
 
+	The exact semantics of wl_surface.offset are role-specific. Refer to
+	the documentation of specific roles for more information.
+
 	Surface location offset is double-buffered state, see
 	wl_surface.commit.