Re: [PATCH] Documentation: Input: Add uinput documentation

From: Peter Hutterer
Date: Wed Mar 22 2017 - 23:25:03 EST


On Wed, Mar 22, 2017 at 11:54:48PM -0300, Marcos Paulo de Souza wrote:
> Hi Peter,
>
> first of all, thanks a lot for reading this patch so quickly and to
> point a lot of things to make this doc way better.
>
> See some notes below.

thanks for all the fixes, much appreciated.
just two comments below:

> On Wed, Mar 22, 2017 at 02:03:31PM +1000, Peter Hutterer wrote:
[...]
> > > + memset(&ie, 0, sizeof(ie));
> > > + ie.type = type;
> > > + ie.code = code;
> > > + ie.value = val;
> > > +
> >
> > memset followed by three out of five filled in seems strange. Just add
> > ie.time.tv_sec = 0;
> > ie.time.tv_usec = 0;
> >
> > ideally, with a comment that states that the timestamp is ignored :)
>
> All the code in this doc is the result of my tests using uinput, so
> somethings were set in my code some time ago and were never touched
> again. Yes, this makes things a way better :)

note that if we ship this as documentation, these become the official
examples so they *have* to be correct. How many times have you copied
something from the examples of a library? Not ideal if there's a bug or just
messy code to begin with :)

> I fixed a lot of things today, the things that are still missing are the
> libevdev example, and the version check. I do think that I can send a
> new version tomorrow.

As for libevdev: just add a link to the documentation, don't add a libevdev
example. libevdev should (and does) provide the examples and you don't want
to ship example code that relies on some other library' API.

Cheers,
Peter