Hinting Find.cmake Files with a custom directory

by

Setting CMAKE_PREFIX_PATH variable serves exactly these purposes: hinting find_* function about location of searched item.

While description of this variable doesn’t note about find_package function, the variable affects it indirectly: the most of Find<name>.cmake scripts use find_library and find_path functions. Note, that all find_* functions have precise algorithm for search items, and paths constructed with CMAKE_PREFIX_PATH are checked before system ones.

Moreover, CMAKE_PREFIX_PATH affects some other search procedures. E.g., if 3rd party package provides <name>Config.cmake script instead of Find<name>.cmake one, this script is also searched for using this variable. pkg_check_modules also uses CMAKE_PREFIX_PATH to search for .pc files describing the package.

CMAKE_PREFIX_PATH variable can be set as environment one (in platform-depending and usage-specific way), as parameter to cmake call:

cmake -DCMAKE_PREFIX_PATH=<additional-path> <other-parameters>

or within CMakeLists.txt file. In the last case it is better to append search directories, so user of you package is able to set the variable too for search packages not shipped with your project:

list(APPEND CMAKE_PREFIX_PATH "${CMAKE_SOURCE_DIR}/dependencies")

Note, that variable CMAKE_PREFIX_PATH doesn’t affect searching for FindXXX.cmake script itself. For specifying the directory where the script is located, use CMAKE_MODULE_PATH variable.

More Related Contents:

  1. What is the proper way to use `pkg-config` from `cmake`?
  2. Using CMake with GNU Make: How can I see the exact commands?
  3. CMake: In which order are files parsed (cache, toolchain, etc.)?
  4. Why is cmake file GLOB evil?
  5. Looking for a ‘cmake clean’ command to clear up CMake output
  6. How to modify environment variables passed to custom CMake target?
  7. Compile with /MT instead of /MD using CMake
  8. Find package Eigen3 for CMake
  9. CMake share library with multiple executables
  10. Listing include_directories in CMake
  11. Recursive list of LINK_LIBRARIES in CMake
  12. CMake – linking to library downloaded from ExternalProject_add()
  13. How to instruct CMake to use the build architecture compiler
  14. What is a CMake generator?
  15. Add Source in a subdirectory to a cmake project
  16. Correct way to use third-party libraries in cmake project
  17. CMake compare to empty string with STREQUAL failed
  18. CMake how to set the build directory to be different than source directory
  19. How to always run command when building regardless of any dependency?
  20. how to add prebuilt object files to executable in cmake
  21. How to run ctest after building my project with cmake
  22. Using CMake, how do I get verbose output from CTest?
  23. How can I add linker flag for libraries with CMake?
  24. How to configure Eclipse CDT for cmake?
  25. CMake : Changing name of Visual Studio and Xcode exectuables depending on configuration in a project generated by CMake
  26. Passing compiler options in CMake command line
  27. How to strip trailing whitespace in CMake variable?
  28. Linking GLEW with CMake
  29. How to print all the properties of a target in cmake?
  30. How to add a custom build type to CMake? (targeting make)

Leave a Comment