From: Andy Shevchenko <andy.shevchenko@gmail.com>
To: Kent Gibson <warthog618@gmail.com>
Cc: Linus Walleij <linus.walleij@linaro.org>,
Bartosz Golaszewski <bgolaszewski@baylibre.com>,
LKML <linux-kernel@vger.kernel.org>,
linux-gpio <linux-gpio@vger.kernel.org>
Subject: Re: [PATCH 0/5] gpio: uapi: documentation improvements
Date: Wed, 14 Oct 2020 20:14:20 +0300 [thread overview]
Message-ID: <CAHp75Vfy9bkny-1gyw7fKf3S=RN-DdZYK40eMC27tE9ApKF6jw@mail.gmail.com> (raw)
In-Reply-To: <20201013132952.GA219958@sol>
On Tue, Oct 13, 2020 at 7:34 PM Kent Gibson <warthog618@gmail.com> wrote:
> On Tue, Oct 13, 2020 at 03:21:47PM +0200, Linus Walleij wrote:
> > On Thu, Oct 8, 2020 at 5:46 PM Bartosz Golaszewski
> > <bgolaszewski@baylibre.com> wrote:
...
> > I am waiting for Kent to respin them addressing Andy's comments
> > on patch 5/5 then they can go in as fixes I think.
> >
>
> I had replied to Andy's comments - I'm prefer with my version than his
> suggestion:
>
> "I'm not keen on that alternative as what it suggests is actually a
> pointer comparison, and even if the user realizes that they may instead
> use "strlen(label) == 0", when they shouldn't be assuming that a null
> terminator is present in the array. I avoided mentioning "string" and
> kept it in terms of the char array for the same reason."
My point is to make documentation less cryptic (= less programming
language stylish).
If you can rephrase it that way - nice! Otherwise, I leave this to Linus.
--
With Best Regards,
Andy Shevchenko
next prev parent reply other threads:[~2020-10-14 17:13 UTC|newest]
Thread overview: 21+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-10-05 7:03 [PATCH 0/5] gpio: uapi: documentation improvements Kent Gibson
2020-10-05 7:03 ` [PATCH 1/5] gpio: uapi: fix kernel-doc warnings Kent Gibson
2020-10-05 7:03 ` [PATCH 2/5] gpio: uapi: comment consistency Kent Gibson
2020-10-05 7:03 ` [PATCH 3/5] gpio: uapi: kernel-doc formatting improvements Kent Gibson
2020-10-05 7:03 ` [PATCH 4/5] gpio: uapi: remove whitespace Kent Gibson
2020-10-05 7:03 ` [PATCH 5/5] gpio: uapi: clarify the meaning of 'empty' char arrays Kent Gibson
2020-10-05 11:01 ` Andy Shevchenko
2020-10-05 13:06 ` Kent Gibson
2020-10-05 11:02 ` [PATCH 0/5] gpio: uapi: documentation improvements Andy Shevchenko
2020-10-05 11:02 ` Andy Shevchenko
2020-10-08 15:46 ` Bartosz Golaszewski
2020-10-13 13:21 ` Linus Walleij
2020-10-13 13:29 ` Kent Gibson
2020-10-14 17:14 ` Andy Shevchenko [this message]
2020-10-14 23:35 ` Kent Gibson
2020-10-19 13:05 ` Linus Walleij
2024-01-09 14:02 Kent Gibson
2024-01-14 14:10 ` Andy Shevchenko
2024-01-14 14:19 ` Kent Gibson
2024-01-14 14:30 ` Andy Shevchenko
2024-01-22 9:03 ` Bartosz Golaszewski
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='CAHp75Vfy9bkny-1gyw7fKf3S=RN-DdZYK40eMC27tE9ApKF6jw@mail.gmail.com' \
--to=andy.shevchenko@gmail.com \
--cc=bgolaszewski@baylibre.com \
--cc=linus.walleij@linaro.org \
--cc=linux-gpio@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=warthog618@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).