From: Peter Hutterer <peter.hutterer@who-t.net>
To: Marcos Paulo de Souza <marcos.souza.org@gmail.com>
Cc: corbet@lwn.net, linux-doc@vger.kernel.org,
dmitry.torokhov@gmail.com, linux-input@vger.kernel.org,
benjamin.tissoires@redhat.com, linux-kernel@vger.kernel.org
Subject: Re: [PATCH] Documentation: Input: Add uinput documentation
Date: Thu, 23 Mar 2017 13:23:56 +1000 [thread overview]
Message-ID: <20170323032356.GA10860@jelly> (raw)
In-Reply-To: <20170323025446.GA10447@xfiles>
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
next prev parent reply other threads:[~2017-03-23 3:23 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-03-22 2:58 [PATCH] Docs: Input: initial uinput documentation Marcos Paulo de Souza
2017-03-22 2:58 ` [PATCH] Documentation: Input: Add " Marcos Paulo de Souza
2017-03-22 4:03 ` Peter Hutterer
2017-03-23 2:54 ` Marcos Paulo de Souza
2017-03-23 3:23 ` Peter Hutterer [this message]
2017-03-21 15:28 ` Marcos Paulo de Souza
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20170323032356.GA10860@jelly \
--to=peter.hutterer@who-t.net \
--cc=benjamin.tissoires@redhat.com \
--cc=corbet@lwn.net \
--cc=dmitry.torokhov@gmail.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-input@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=marcos.souza.org@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).