[libgpiod][PATCH v2] README: list the development packages required to build the library

[libgpiod][PATCH v2] README: list the development packages required to build the library

[Bartosz Golaszewski]

From: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>

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.

Signed-off-by: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
---
Changes since v1:
- reword the part about missing libraries

 README | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/README b/README
index a6f24d1..a01cfc5 100644
--- a/README
+++ b/README
@@ -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:
-- 
2.43.0

Re: [libgpiod][PATCH v2] README: list the development packages required to build the library

[Kent Gibson]

On Fri, Jul 05, 2024 at 09:33:14AM +0200, Bartosz Golaszewski wrote:
> From: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
>
> 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.
>
> Signed-off-by: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
> ---
> Changes since v1:
> - reword the part about missing libraries
>
>  README | 5 +++++
>  1 file changed, 5 insertions(+)
>
> diff --git a/README b/README
> index a6f24d1..a01cfc5 100644
> --- a/README
> +++ b/README
> @@ -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:
> --
> 2.43.0
>

Reviewed-by: Kent Gibson <warthog618@gmail.com>

Re: [libgpiod][PATCH v2] README: list the development packages required to build the library

[Bartosz Golaszewski]

From: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>


On Fri, 05 Jul 2024 09:33:14 +0200, Bartosz Golaszewski wrote:
> 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,
-- 
Bartosz Golaszewski <bartosz.golaszewski@linaro.org>