What is the proper way to use `pkg-config` from `cmake`?

by

First of, the call:

include(FindPkgConfig)

should be replaced with:

find_package(PkgConfig)

The find_package() call is more flexible and allows options such as REQUIRED, that do things automatically that one would have to do manually with include().

Secondly, manually calling pkg-config should be avoid when possible. CMake comes with a rich set of package definitions, found in Linux under /usr/share/cmake-3.0/Modules/Find*cmake. These provide more options and choice for the user than a raw call to pkg_search_module().

As for the mentioned hypothetical target_use() command, CMake already has that built-in in a way with PUBLIC|PRIVATE|INTERFACE. A call like target_include_directories(mytarget PUBLIC ...) will cause the include directories to be automatically used in every target that uses mytarget, e.g. target_link_libraries(myapp mytarget). However this mechanism seems to be only for libraries created within the CMakeLists.txt file and does not work for libraries acquired with pkg_search_module(). The call add_library(bar SHARED IMPORTED) might be used for that, but I haven’t yet looked into that.

As for the main question, this here works in most cases:

find_package(PkgConfig REQUIRED)
pkg_check_modules(SDL2 REQUIRED sdl2)
...
target_link_libraries(testapp ${SDL2_LIBRARIES})
target_include_directories(testapp PUBLIC ${SDL2_INCLUDE_DIRS})
target_compile_options(testapp PUBLIC ${SDL2_CFLAGS_OTHER})

The SDL2_CFLAGS_OTHER contains defines and other flags necessary for a successful compile. The flags SDL2_LIBRARY_DIRS and SDL2_LDFLAGS_OTHER are however still ignored, no idea how often that would become a problem.

More documentation here http://www.cmake.org/cmake/help/v3.0/module/FindPkgConfig.html

More Related Contents:

  1. CMake link to external library
  2. Hinting Find.cmake Files with a custom directory
  3. What’s the CMake syntax to set and use variables?
  4. CMake + GoogleTest
  5. CMake: use a custom linker
  6. Passing compiler options cmake
  7. Getting a CMake Error: Cannot specify link libraries for target which is not built by the project
  8. Switching between GCC and Clang/LLVM using CMake
  9. How do I tell CMake to link in a static library in the source directory?
  10. CMake: Print out all accessible variables in a script
  11. Environment variable used by CMake to detect Visual C++ compiler tools for Ninja
  12. Why add header files into ADD_LIBRARY/ADD_EXECUTABLE command in CMake
  13. CMake : How to get the name of all subdirectories of a directory?
  14. Does CMake offer a method to set the working directory for a given build system to use when running/debugging the project?
  15. CMake: How to add dependency on linker script for executable
  16. cmake: Selecting a generator within CMakeLists.txt
  17. Setting CMAKE_INSTALL_PREFIX from CMakeLists.txt file
  18. Tell CMake to use C++ compiler for C files coming from CMake?
  19. How do I debug CMakeLists.txt files?
  20. CMake target_link_libraries Interface Dependencies
  21. What is common way to split string into list with CMAKE?
  22. Difference between add_compile_options and SET(CMAKE_CXX_FLAGS…)
  23. Simple find_package config file example
  24. cmake add_custom_command
  25. Check CMake Cache Variable in Toolchain File
  26. How to tell CMake to use relative paths
  27. Retrieve all link flags in CMake
  28. Specifying build directory within CMakeLists file
  29. How can I debug CMakeLists.txt files?
  30. Linking GLEW with CMake

Leave a Comment