且构网

分享程序员开发的那些事...
且构网 - 分享程序员编程开发的那些事

Cmake 无法使用“link_directories"找到库

更新时间:2022-10-15 08:49:26

不要在 CMake 中像这样使用 link_directories.

这是一个常见的初学者错误,因为许多其他构建环境都是这样工作的,但在 CMake 中它只是自找麻烦.甚至手册页也特别反对它:

请注意,此命令 [link_directories] 很少需要.图书馆位置返回by find_package()find_library() 是绝对路径.通过这些直接到 target_link_libraries() 的绝对库文件路径命令.CMake 将确保链接器找到它们.

因此,总是将绝对路径传递给 target_link_libraries 并使用 find_library 解析链接目录:

find_library(PROTOBUF_LIBRARY protobuf HINTS/usr/lib/x86_64-linux-gnu)目标链接库(测试 PUBLIC ${PROTOBUF_LIBRARY})

这有一个巨大的好处,如果找不到预期的库,您可能会在 CMake 配置时得到诊断,而不是在编译时出现随机链接器错误.此外,如果目标机器具有非标准目录布局,这允许用户通过 GUI 指定库位置.

因此,如果它不能立即工作,请务必检查 find_library 调用的结果并查阅联机帮助页以找出它没有按预期找到您的库的原因.>

I Ubuntu, I am learning about cmake and make, and just trying a simple example. I have two directories: src and build. In src, I have two files: main.cpp, and CMakeLists.txt, which has (only) the following text:

add_executable(test main.cpp)
link_directories(/usr/lib/x86_64-linux-gnu)
target_link_libraries(test protobuf)

In /usr/lib/x86_64-linux-gnu, there is a shared library called libprotobuf.so, which I want to link against. My main.cpp uses functions in this library, by including the releveant header file, #include <google/protobuf/message.h>.

Now, in my build directory, I run cmake ../src, and then make. However, I then get linker errors telling me that there are undefined references to some of the functions in the protobuf library. If I do a search through all the files and subdirectories in build, there is not mention of anything related to protobuf.

However, if I remove the link_directories line in my CMakeLists.txt file, and instead write the full path to the library when specifying the executable, i.e. target_link_libraries(test /usr/lib/x86_64-linux-gnu/libprotobuf.so), it compiles and links fine.

Why is link_directories not allowing cmake to find this library?

Do not use link_directories like this in CMake.

This is a common beginner's mistake, as many other build environments work like this, but in CMake it's just asking for trouble. Even the manpage specifically advises against it:

Note that this command [link_directories] is rarely necessary. Library locations returned by find_package() and find_library() are absolute paths. Pass these absolute library file paths directly to the target_link_libraries() command. CMake will ensure the linker finds them.

So instead, always pass absolute paths to target_link_libraries and use find_library to resolve the link directory:

find_library(PROTOBUF_LIBRARY protobuf HINTS /usr/lib/x86_64-linux-gnu)
target_link_libraries(test PUBLIC ${PROTOBUF_LIBRARY})

This has the huge benefit that you will probably get a diagnostic at CMake configure time if the expected library cannot be found, instead of a random linker error at compile time. Also, this allows the user to specify a library location via the GUI if the target machine has a non-standard directory layout.

So if it doesn't work right away, be sure to check the result of the find_library call and consult the manpage to track down why it doesn't find your library as intended.