Skip to contentSkip to conversation

README: list the development packages required to build the library

PATCH Applied Bartosz Golaszewski 2 participants 3 messages Jul 5, 2024 – Jul 8, 2024 GPIO

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 README: list the development packages required to build the library

From: Bartosz Golaszewski <[email protected]>

The error messages emitted by configure when either libtool, pkg-config or autoconf-archive packages are missing on the host are not very clear and seem to cause confusion among users building the project from sources. List the required packages in the README.

---
Changes since v1:
- reword the part about missing libraries

 README | 5 +++++
 1 file changed, 5 insertions(+)
README +5 -0
index a6f24d1..a01cfc5 100644
@@ -34,6 +34,11 @@ BUILDING
 This is a pretty standard autotools project. The core C library does not have
 any external dependencies other than the standard C library with GNU extensions.
 
+The build system requires autotools, autoconf-archive, libtool and pkg-config
+to be installed on the host system for the basic build. Development files for
+additional libraries may be required depending on selected options. The
+configure script will report any missing additional required dependencies.
+
 The command-line tools optionally depend on libedit for the interactive feature.
 
 To build the project (including command-line utilities) run:
Signature · 1 line
2.43.0
Reviewed-by on v2 1/1
#1 lore raw
Quoted 32 lines · Bartosz Golaszewski

From: Bartosz Golaszewski <[email protected]>

The error messages emitted by configure when either libtool, pkg-config or autoconf-archive packages are missing on the host are not very clear and seem to cause confusion among users building the project from sources. List the required packages in the README.

---
Changes since v1:
- reword the part about missing libraries

 README | 5 +++++
 1 file changed, 5 insertions(+)
README +5 -1
index a6f24d1..a01cfc5 100644
@@ -34,6 +34,11 @@ BUILDING
 This is a pretty standard autotools project. The core C library does not have
 any external dependencies other than the standard C library with GNU extensions.
 
+The build system requires autotools, autoconf-archive, libtool and pkg-config
+to be installed on the host system for the basic build. Development files for
+additional libraries may be required depending on selected options. The
+configure script will report any missing additional required dependencies.
+
 The command-line tools optionally depend on libedit for the interactive feature.
 
 To build the project (including command-line utilities) run:
--
Quoted 2 lines

2.43.0

author Applied
#2 lore raw
In reply to Bartosz Golaszewski

From: Bartosz Golaszewski <[email protected]>

Quoted 6 lines · Bartosz Golaszewski

The error messages emitted by configure when either libtool, pkg-config or autoconf-archive packages are missing on the host are not very clear and seem to cause confusion among users building the project from sources. List the required packages in the README.

Applied, thanks!

[1/1] README: list the development packages required to build the library

      commit: 099697530033ceec583b67abfda1df152430fae3

Best regards,

Signature · 1 line
Bartosz Golaszewski <[email protected]>