linux-gpio.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Kent Gibson <warthog618@gmail.com>
To: Bartosz Golaszewski <brgl@bgdev.pl>
Cc: Linus Walleij <linus.walleij@linaro.org>,
	Phil Howard <phil@gadgetoid.com>,
	Erik Schilling <erik.schilling@linaro.org>,
	linux-gpio@vger.kernel.org,
	Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
Subject: Re: [libgpiod][PATCH 2/2] README: mention the linux v5.10 requirement for libgpiod v2
Date: Mon, 15 Jan 2024 19:30:53 +0800	[thread overview]
Message-ID: <20240115113053.GA45220@rigel> (raw)
In-Reply-To: <20240115111929.28628-2-brgl@bgdev.pl>

On Mon, Jan 15, 2024 at 12:19:29PM +0100, Bartosz Golaszewski wrote:
> From: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
>
> Major version 2 of libgpiod requires linux kernel uAPI v2 to be available.
> This was released in linux v5.10 so mention it in the README.
>
> Signed-off-by: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
> ---
>  README | 6 ++++--
>  1 file changed, 4 insertions(+), 2 deletions(-)
>
> diff --git a/README b/README
> index 632aab3..7680915 100644
> --- a/README
> +++ b/README
> @@ -8,8 +8,10 @@ libgpiod
>               character device (gpiod stands for GPIO device)
>
>  Since linux 4.8 the GPIO sysfs interface is deprecated. User space should use
> -the character device instead. This library encapsulates the ioctl calls and
> -data structures behind a straightforward API.
> +the character device instead. Version 2 of libgpiod requires the new GPIO
> +character device uAPI to be available which was first released in linux v5.10.
> +This library encapsulates the ioctl calls and data structures behind a
> +straightforward API.


This wording is a bit awkward.  How about:

  Version 2 of libgpiod requires GPIO character device uAPI v2 which was
  first released in linux v5.10.

I prefer the "v2" over "new".  I would settle for "latest".
The "to be available" feels a bit redundant.

I also tend to drop the "v" from Linux release versions, and capitalise
Linux. So I would use Linux 5.10. Is there a preference?

Patch 1 looks good to me.

Cheers,
Kent.

  reply	other threads:[~2024-01-15 11:30 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-01-15 11:19 [libgpiod][PATCH v2 1/2] README: add info about the github page Bartosz Golaszewski
2024-01-15 11:19 ` [libgpiod][PATCH 2/2] README: mention the linux v5.10 requirement for libgpiod v2 Bartosz Golaszewski
2024-01-15 11:30   ` Kent Gibson [this message]
2024-01-16  9:18 ` [libgpiod][PATCH v2 1/2] README: add info about the github page 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=20240115113053.GA45220@rigel \
    --to=warthog618@gmail.com \
    --cc=bartosz.golaszewski@linaro.org \
    --cc=brgl@bgdev.pl \
    --cc=erik.schilling@linaro.org \
    --cc=linus.walleij@linaro.org \
    --cc=linux-gpio@vger.kernel.org \
    --cc=phil@gadgetoid.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).