doc: update doc to explicitly state that the seat isn't referenced
authorPeter Hutterer <peter.hutterer@who-t.net>
Tue, 24 May 2016 01:33:50 +0000 (11:33 +1000)
committerPeter Hutterer <peter.hutterer@who-t.net>
Sun, 29 May 2016 22:31:52 +0000 (08:31 +1000)
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
(cherry picked from commit c2dfe504ed7110e1cf85c52f7b8495dc0b5f08d8)

src/libinput.h

index 631848423533b5a1dac34b6710b83a1949260180..5b08035f53af2d130aba7938991945775832bc4a 100644 (file)
@@ -3066,6 +3066,11 @@ libinput_device_get_output_name(struct libinput_device *device);
  * seat name pair at any given time, but if no external reference is kept, it
  * may be destroyed if no device belonging to it is left.
  *
+ * The returned seat is not refcounted and may become invalid after
+ * the next call to libinput. Use libinput_seat_ref() and
+ * libinput_seat_unref() to continue using the handle outside of the
+ * immediate scope.
+ *
  * @param device A previously obtained device
  * @return The seat this input device belongs to
  */