| Message ID | 20240115111929.28628-2-brgl@bgdev.pl |
|---|---|
| State | New |
| Headers | show |
| Series | [libgpiod,v2,1/2] README: add info about the github page | expand |
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.
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. RATIONALE ---------