[PATCH libinput 3/3] Expand documentation for libinput_udev_create_for_seat

[Jonas Ådahl]

On Fri, Mar 21, 2014 at 02:13:22PM +1000, Peter Hutterer wrote:
> Signed-off-by: Peter Hutterer <peter.hutterer at who-t.net>
> ---
>  src/libinput.h | 6 ++++++
>  1 file changed, 6 insertions(+)
> 
> diff --git a/src/libinput.h b/src/libinput.h
> index d6bf9f8..3e09871 100644
> --- a/src/libinput.h
> +++ b/src/libinput.h
> @@ -691,6 +691,12 @@ struct libinput_interface {
>   * the given seat ID. New devices or devices removed will appear as events
>   * during libinput_dispatch.
>   *
> + * libinput_udev_create_for_seat() fails for internal values only. No

What does internal values mean? It fails for invalid input, OOM, libudev
errors, etc, but how is that relevant? Maybe its enough to just say that
this call will not fail even if no input devices are successfully added,
and that if not supported, or if failed to open, devices will be ignored
until next resume.

Jonas

> + * guarantee is made that a device is available once the call finishes, and
> + * only devices handled by libinput are avialable. Devices that cannot be
> + * opened in @ref libinput_interface::open_restricted or do not match
> + * libinput requirements are ignored.
> + *
>   * @param interface The callback interface
>   * @param user_data Caller-specific data passed to the various callback
>   * interfaces.
> -- 
> 1.8.5.3
> 
> _______________________________________________
> wayland-devel mailing list
> wayland-devel at lists.freedesktop.org
> http://lists.freedesktop.org/mailman/listinfo/wayland-devel