From 561cfd009ee4085f53d3ba570ee952cab14c222a Mon Sep 17 00:00:00 2001
From: Peter Hutterer <peter.hutterer@who-t.net>
Date: Fri, 6 Dec 2024 10:56:07 +1000
Subject: [PATCH] doc: unwinding state before stop_emulating is the caller's
 responsibility

Part-of: <https://gitlab.freedesktop.org/libinput/libei/-/merge_requests/308>
---
 src/libei.h | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/libei.h b/src/libei.h
index a9588dd..ba1c451 100644
--- a/src/libei.h
+++ b/src/libei.h
@@ -1474,6 +1474,10 @@ ei_device_start_emulating(struct ei_device *device, uint32_t sequence);
  * Notify the EIS implementation that the given device is no longer sending
  * events. See ei_device_start_emulating() for details.
  *
+ * If the device is not logically in a neutral state, that state is left
+ * as-is. It is the caller's responsibility to release any buttons, keys, touch
+ * sequences, etc. when stopping emulation to avoid adverse side effects.
+ *
  * This method is only available on an ei sender context.
  */
 void