README: list the development packages required to build the library
PATCH 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.
--- README | 5 +++++ 1 file changed, 5 insertions(+)
README +5 -0
@@ -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 typically prompt the user for them clearly when missing. + 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
Quoted 17 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.
Signed-off-by Bartosz Golaszewski <[email protected]>--- README | 5 +++++ 1 file changed, 5 insertions(+)README +0
-0
README BUILDING · line 41
Quoted 8 lines
README +5
-0@@ -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 typically prompt the user for them clearly when missing. +
typically? Shouldn't that always be the case?
"prompt" makes it seem interactive.
I would reword as "The configure script will report any missing additional required dependencies."
Cheers,
Kent.
Quoted 22 lines · Kent Gibson
Quoted 20 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.
Signed-off-by Bartosz Golaszewski <[email protected]>--- README | 5 +++++ 1 file changed, 5 insertions(+)README +0
-0@@ -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.
Quoted 8 lines
README BUILDING · line 41
Quoted 5 lines
README +5
-0+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 typically prompt the user for them clearly when missing. +typically? Shouldn't that always be the case?
I used the word "typically" because I am simply not sure if *all* potentially missing dependencies will get reported correctly. We identified the ones listed above as causing confusing error message. Maybe there are more, just unreported (yet)?
Quoted 4 lines
"prompt" makes it seem interactive.
I would reword as "The configure script will report any missing additional required dependencies."
Sure, can use this instead.
Bart
Quoted 2 lines
Cheers,
Kent.
Quoted 32 lines · Bartosz Golaszewski
Quoted 22 lines · Kent Gibson
Quoted 20 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.
Signed-off-by Bartosz Golaszewski <[email protected]>--- README | 5 +++++ 1 file changed, 5 insertions(+)README +0
-0@@ -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.Quoted 8 lines
README BUILDING · line 41
Quoted 5 lines
README +5
-0+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 typically prompt the user for them clearly when missing. +typically? Shouldn't that always be the case?
Quoted 5 lines
I used the word "typically" because I am simply not sure if *all* potentially missing dependencies will get reported correctly. We identified the ones listed above as causing confusing error message. Maybe there are more, just unreported (yet)?
You have covered the core dependencies, required just to get configure to run, so you can assume those are present.
I would consider any other that case produced a confusing error to be a bug to be fixed when found.
The problem with the "typically" is it normalises such a failure, so then it wont be reported.
Cheers,
Kent.
Quoted 11 lines
Quoted 4 lines
"prompt" makes it seem interactive.
I would reword as "The configure script will report any missing additional required dependencies."Sure, can use this instead.
Bart
Quoted 2 lines
Cheers,
Kent.