Remove warning comment from FORCE_SYNC
authorPeter Hutterer <peter.hutterer@who-t.net>
Wed, 11 Sep 2013 01:17:08 +0000 (11:17 +1000)
committerPeter Hutterer <peter.hutterer@who-t.net>
Wed, 11 Sep 2013 02:10:15 +0000 (12:10 +1000)
There is a legitimate reason for clients to force a sync on the device.
X.Org drivers lose the fd when the device is disabled and re-enabled. When
the device comes back, a simple libevdev_change_fd() doesn't update the status
on the device.

Button states, etc. may have changed, etc. So a driver may call FORCE_SYNC after
re-connecting to the fd to make sure the library and the driver get the current
state of the device.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Acked-by: Benjamin Tissoires <benjamin.tissoires@gmail.com>
libevdev/libevdev.h

index 0fcfb70..5158586 100644 (file)
@@ -294,9 +294,8 @@ struct libevdev;
 enum libevdev_read_flag {
        LIBEVDEV_READ_FLAG_SYNC         = 1, /**< Process data in sync mode */
        LIBEVDEV_READ_FLAG_NORMAL       = 2, /**< Process data in normal mode */
-       LIBEVDEV_READ_FLAG_FORCE_SYNC   = 4, /**< Pretend the next event is a SYN_DROPPED. There is
-                                                 no reason to ever use this except for
-                                                 automated tests, so don't. */
+       LIBEVDEV_READ_FLAG_FORCE_SYNC   = 4, /**< Pretend the next event is a SYN_DROPPED and
+                                                 require the caller to sync */
        LIBEVDEV_READ_FLAG_BLOCKING     = 8, /**< The fd is not in O_NONBLOCK and a read may block */
 
 };