Skip to contentSkip to conversation

README: add info about the github page

PATCH Applied Bartosz Golaszewski 2 participants 4 messages Jan 15, 2024 – Jan 16, 2024 GPIO

lore
Share & tools
lore

Bartosz Golaszewski

author
#0 lore raw

PATCH v2 1/2 README: add info about the github page

From: Bartosz Golaszewski <[email protected]>

The github page over at https://github.com/brgl/libgpiod has been reopened for bug reports and discussions. Add a link and a mention to the README file.

Signed-off-by Bartosz Golaszewski <[email protected]>
Reviewed-by Erik Schilling <[email protected]>

---
Resending with [libgpiod] tag

v1 -> v2:
- add a link to the kernel.org mirror containing release tarballs

 README | 7 +++++++
 1 file changed, 7 insertions(+)
README +7 -0
index 69128dc..632aab3 100644
@@ -294,9 +294,16 @@ Those also provide examples of the expected formatting.
 Allow some time for your e-mail to propagate to the list before retrying,
 particularly if there are no e-mails in the list more recent than yours.
 
+There is a libgpiod github page[7] available for reporting bugs and general
+discussions and although PRs can be submitted and discussed, upstreambound
+patches need to go through the mailing list nevertheless while release
+tarballs should be fetched from kernel.org[8].
+
 [1] https://github.com/kward/shunit2
 [2] http://vger.kernel.org/vger-lists.html#linux-gpio
 [3] https://docs.kernel.org/process/email-clients.html
 [4] https://docs.kernel.org/process/coding-style.html
 [5] https://docs.kernel.org/process/submitting-patches.html
 [6] https://lore.kernel.org/linux-gpio/
+[7] https://github.com/brgl/libgpiod
+[8] https://mirrors.edge.kernel.org/pub/software/libs/libgpiod/
Signature · 1 line
2.40.1
author
#1 lore raw

PATCH 2/2 README: mention the linux v5.10 requirement for libgpiod v2

From: Bartosz Golaszewski <[email protected]>

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 <[email protected]>
---
 README | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)
README +4 -2
index 632aab3..7680915 100644
@@ -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
 ---------
Signature · 1 line
2.40.1
#2 lore raw

Re: [libgpiod][PATCH 2/2] README: mention the linux v5.10 requirement for libgpiod v2

Quoted 15 lines · Bartosz Golaszewski

From: Bartosz Golaszewski <[email protected]>

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 <[email protected]>
---
 README | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)
README +0 -0
index 632aab3..7680915 100644

README libgpiod · line 14

Quoted 9 lines
README +4 -2
@@ -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.