From 4640ccac85b6176ec6cac513ebc68e9279e8fdfc Mon Sep 17 00:00:00 2001 From: James Le Cuirot Date: Sat, 2 Sep 2023 16:18:30 +0100 Subject: [PATCH] build: Generate better pkg-config file for SYSROOT builds The -I and -L flags you use to build should not necessarily be the same ones you bake into installed files. If you are building with dependencies located under a SYSROOT then the installed files should have no knowledge of that SYSROOT. For example, if the build requires `-L/path/to/sysroot/usr/lib/foo` then only `-L/usr/lib/foo` should be baked into the installed files. pkg-config is SYSROOT-aware, so this issue can be sidestepped by using the `Requires` field rather than the `Libs` and `Cflags` fields. This is easily resolved if you rely solely on pkg-config, but this project falls back to standard Autoconf checks, so a little more effort is required. Unfortunately, this issue cannot feasibly be resolved for CMake. `find_package` is used rather than `pkg_check_modules`, so we cannot tell whether a pkg-config file for each dependency is present or not, even if `find_package` uses pkg-config behind the scenes. The CMake build does not record any dependency -I or -L flags into the pkg-config file anyway. This is a problem in itself, although these dependencies are most likely installed to standard locations. Meson is very much better at handling this, as it generates the pkg-config file automatically using the correct logic. --- CMakeLists.txt | 1 + configure.ac | 47 +++++++++++++++++++++++++++++------- libxml-2.0-uninstalled.pc.in | 6 ++--- libxml-2.0.pc.in | 6 ++--- 4 files changed, 45 insertions(+), 15 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 68eb6869..1e6d6164 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -652,6 +652,7 @@ set(XML_INCLUDEDIR "-I\${includedir}/libxml2") set(XML_LIBDIR "-L\${libdir}") set(XML_LIBS "-lxml2") set(XML_PRIVATE_LIBS "${Z_LIBS} ${LZMA_LIBS} ${THREAD_LIBS} ${ICONV_LIBS} ${ICU_LIBS} ${LIBM} ${WINSOCK_LIBS}") +set(XML_PC_LIBS "${XML_PRIVATE_LIBS}") file(RELATIVE_PATH PACKAGE_RELATIVE_PATH "${CMAKE_INSTALL_FULL_LIBDIR}/pkgconfig" "${CMAKE_INSTALL_PREFIX}") string(REGEX REPLACE "/$" "" PACKAGE_RELATIVE_PATH "${PACKAGE_RELATIVE_PATH}") diff --git a/configure.ac b/configure.ac index 9b5379e5..580050de 100644 --- a/configure.ac +++ b/configure.ac @@ -285,6 +285,12 @@ else fi fi +XML_PRIVATE_LIBS= +XML_PRIVATE_CFLAGS= +XML_PC_LIBS= +XML_PC_CFLAGS= +XML_PC_REQUIRES= + dnl dnl Checks for header files. dnl @@ -844,7 +850,7 @@ dnl if test "${NEED_TRIO}" = "1" ; then echo Adding trio library for string functions WITH_TRIO=1 -else +else WITH_TRIO=0 fi AM_CONDITIONAL(WITH_TRIO_SOURCES, test "${NEED_TRIO}" = "1") @@ -963,7 +969,7 @@ else if test "x$Z_DIR" = "x"; then # Try pkg-config first so that static linking works. PKG_CHECK_MODULES([Z],[zlib], - [WITH_ZLIB=1], + [WITH_ZLIB=1; XML_PC_REQUIRES="${XML_PC_REQUIRES} zlib"], [:]) fi @@ -988,10 +994,15 @@ else else Z_LIBS="-lz" fi]) + XML_PC_CFLAGS="${XML_PC_CFLAGS} ${Z_CFLAGS}" + XML_PC_LIBS="${XML_PC_LIBS} ${Z_LIBS}" ) CPPFLAGS=$_cppflags LIBS=$_libs fi + + XML_PRIVATE_CFLAGS="${XML_PRIVATE_CFLAGS} ${Z_CFLAGS}" + XML_PRIVATE_LIBS="${XML_PRIVATE_LIBS} ${Z_LIBS}" fi AC_SUBST(WITH_ZLIB) @@ -1011,7 +1022,7 @@ else if test "x$LZMA_DIR" = "x"; then # Try pkg-config first so that static linking works. PKG_CHECK_MODULES([LZMA],[liblzma], - [WITH_LZMA=1], + [WITH_LZMA=1; XML_PC_REQUIRES="${XML_PC_REQUIRES} liblzma"], [:]) fi @@ -1034,10 +1045,15 @@ else else LZMA_LIBS="-llzma" fi]) + XML_PC_CFLAGS="${XML_PC_CFLAGS} ${LZMA_CFLAGS}" + XML_PC_LIBS="${XML_PC_LIBS} ${LZMA_LIBS}" ) CPPFLAGS=$_cppflags LIBS=$_libs fi + + XML_PRIVATE_CFLAGS="${XML_PRIVATE_CFLAGS} ${LZMA_CFLAGS}" + XML_PRIVATE_LIBS="${XML_PRIVATE_LIBS} ${LZMA_LIBS}" fi AC_SUBST(WITH_LZMA) AM_CONDITIONAL(WITH_LZMA_SOURCES, test "$WITH_LZMA" = "1") @@ -1091,7 +1107,6 @@ dnl dnl Checks for ICU library. dnl WITH_ICU=0 -ICU_LIBS="" if test "$with_icu" = "no" || test "$with_icu" = "" ; then echo Disabling ICU support @@ -1099,7 +1114,7 @@ else # Try pkg-config first so that static linking works. # If this succeeeds, we ignore the WITH_ICU directory. PKG_CHECK_MODULES([ICU], [icu-i18n], [ - WITH_ICU=1 + WITH_ICU=1; XML_PC_REQUIRES="${XML_PC_REQUIRES} icu-i18n" m4_ifdef([PKG_CHECK_VAR], [PKG_CHECK_VAR([ICU_DEFS], [icu-i18n], [DEFS])]) if test "x$ICU_DEFS" != "x"; then @@ -1113,9 +1128,11 @@ else WITH_ICU=1 ICU_CFLAGS=`${ICU_CONFIG} --cflags` ICU_LIBS=`${ICU_CONFIG} --ldflags` + XML_PC_CFLAGS="${XML_PC_CFLAGS} ${ICU_CFLAGS}" + XML_PC_LIBS="${XML_PC_LIBS} ${ICU_LIBS}" else - _cppflags="${CPPFLAGS}" - _libs="${LIBS}" + _cppflags="${CPPFLAGS}" + _libs="${LIBS}" if test "$with_icu" != "yes" ; then ICU_DIR=$with_icu CPPFLAGS="${CPPFLAGS} -I$ICU_DIR/include" @@ -1130,10 +1147,15 @@ else ICU_CFLAGS="-I$ICU_DIR/include" ICU_LIBS="-L$ICU_DIR/lib $ICU_LIBS" fi])]) + XML_PC_CFLAGS="${XML_PC_CFLAGS} ${ICU_CFLAGS}" + XML_PC_LIBS="${XML_PC_LIBS} ${ICU_LIBS}" CPPFLAGS=$_cppflags LIBS=$_libs fi fi + + XML_PRIVATE_CFLAGS="${XML_PRIVATE_CFLAGS} ${ICU_CFLAGS}" + XML_PRIVATE_LIBS="${XML_PRIVATE_LIBS} ${ICU_LIBS}" fi AC_SUBST(WITH_ICU) @@ -1148,8 +1170,15 @@ fi XML_LIBS="-lxml2" XML_LIBTOOLLIBS="libxml2.la" -XML_PRIVATE_LIBS="$Z_LIBS $LZMA_LIBS $THREAD_LIBS $ICONV_LIBS $ICU_LIBS $LIBM $NET_LIBS" -XML_PRIVATE_CFLAGS="$Z_CFLAGS $LZMA_CFLAGS $THREAD_CFLAGS $ICONV_CFLAGS $ICU_CFLAGS" +XML_PRIVATE_LIBS="${XML_PRIVATE_LIBS} $THREAD_LIBS $ICONV_LIBS $LIBM $NET_LIBS" +XML_PRIVATE_CFLAGS="${XML_PRIVATE_CFLAGS} $THREAD_CFLAGS $ICONV_CFLAGS" + +AC_SUBST(XML_PC_LIBS) +AC_SUBST(XML_PC_CFLAGS) +AC_SUBST(XML_PC_REQUIRES) +AM_SUBST_NOTMAKE(XML_PC_LIBS) +AM_SUBST_NOTMAKE(XML_PC_CFLAGS) +AM_SUBST_NOTMAKE(XML_PC_REQUIRES) AC_SUBST(AM_CFLAGS) AC_SUBST(AM_LDFLAGS) diff --git a/libxml-2.0-uninstalled.pc.in b/libxml-2.0-uninstalled.pc.in index 0c3186f7..d6a2123f 100644 --- a/libxml-2.0-uninstalled.pc.in +++ b/libxml-2.0-uninstalled.pc.in @@ -7,7 +7,7 @@ modules=@WITH_MODULES@ Name: libXML Version: @VERSION@ Description: libXML library version2. -Requires: +Requires: @XML_PC_REQUIRES@ Libs: -L${libdir} @XML_LIBS@ -Libs.private: @XML_PRIVATE_LIBS@ @LIBS@ -Cflags: @XML_INCLUDEDIR@ @XML_CFLAGS@ +Libs.private: @XML_PC_LIBS@ @LIBS@ +Cflags: @XML_INCLUDEDIR@ @XML_CFLAGS@ @XML_PC_CFLAGS@ diff --git a/libxml-2.0.pc.in b/libxml-2.0.pc.in index 88e3963b..a5b718e2 100644 --- a/libxml-2.0.pc.in +++ b/libxml-2.0.pc.in @@ -7,7 +7,7 @@ modules=@WITH_MODULES@ Name: libXML Version: @VERSION@ Description: libXML library version2. -Requires: +Requires: @XML_PC_REQUIRES@ Libs: -L${libdir} @XML_LIBS@ -Libs.private: @XML_PRIVATE_LIBS@ @LIBS@ -Cflags: @XML_INCLUDEDIR@ @XML_CFLAGS@ +Libs.private: @XML_PC_LIBS@ @LIBS@ +Cflags: @XML_INCLUDEDIR@ @XML_CFLAGS@ @XML_PC_CFLAGS@