如何告诉 CMake 安装目录依赖于虚假目标？

Question

如何在 CMake 中实现以下功能（使用版本 2.8.5）？我有一个由名为 doc 的自定义目标生成的文档，我希望在安装或 CPack'ing 时包含该文档的输出。

add_custom_target( doc "${DOXYGEN_EXECUTABLE}" Doxyfile )
install( DIRECTORY ${CMAKE_BINARY_DIR}/doc DESTINATION doc )

Doxyfile 告诉 Doxygen 将文档放在 ${CMAKE_BINARY_DIR}/doc 中。

如果我在构建目录中执行此操作：

make doc
cpack

一切正常，因为第一行创建 install 目标所依赖的目录。

但是，如果我有一个新的构建（因此 ${CMAKE_BINARY_DIR}/doc 尚不存在），并且我直接调用 CPack：

cpack

那么它会抱怨找不到 ${CMAKE_BINARY_DIR}/ doc：

CMake Error at <snip>/build/cmake_install.cmake:36 (FILE):
  file INSTALL cannot find "<snip>/build/doc".

我也尝试了以下操作：

add_custom_command( OUTPUT ${CMAKE_BINARY_DIR}/doc COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_BINARY_DIR}/Doxyfile )
install( DIRECTORY ${CMAKE_BINARY_DIR}/doc DESTINATION doc )

但我仍然遇到相同的 CPack 错误，并且在构建目录中执行 make doc 也不起作用。

因此，如果我在 cpack 之前手动执行 make doc ，它可以与本文顶部的配置配合使用，但是我如何告诉 cmake/cpack install 指令依赖于自定义目标 doc，以便在调用 cpack 或 make install 时自动生成文档？

谢谢！

Answer 1

可能您需要 ALL 关键字：

add_custom_target( doc ALL "${DOXYGEN_EXECUTABLE}" Doxyfile )

---

更新：

目前 cmake 不提供向其内置目标添加自定义依赖项的选项（例如 all 、安装、测试等）。而且似乎在不久的将来它不会提供此选项 - 请参阅 http:// public.kitware.com/Bug/view.php?id=8438

但是，仍然可以通过一些技巧/解决方法来实现所需的行为。例如，您可以在安装步骤开始时直接运行 make 工具。

因此使用风险自负：

add_custom_target(hack ${CMAKE_COMMAND} -E echo "Hacking install target")
if("${CMAKE_GENERATOR}" MATCHES Make)
    install(CODE "execute_process(COMMAND ${CMAKE_BUILD_TOOL} hack WORKING_DIRECTORY \"${CMAKE_CURRENT_BINARY_DIR}\")")
endif()

Answer 2

我在 CMakeList.txt 中对此进行了一些更改，以便在 Linux 和 Windows 上构建

install(CODE "execute_process(COMMAND ${CMAKE_BUILD_TOOL} hack WORKING_DIRECTORY \"${CMAKE_CURRENT_BINARY_DIR}\")") endif()

这是我的解决方案。仅当需要 doc 或安装目标时（在 Visual Studio 上，编译 INSTALL 项目时），它才不会始终构建“全部”文档。
这个解决方案并不完整。例如，它不适用于 MinGW，但是......

set( DOXYFILE_OUTPUT_DIR ${PROJECT_BINARY_DIR}/doc )
#-- Configure the Template Doxyfile
configure_file(Doxyfile.in ${PROJECT_BINARY_DIR}/Doxyfile  @ONLY IMMEDIATE)

#-- Add a custom target to run Doxygen
add_custom_target (doc
    COMMAND ${DOXYGEN_EXECUTABLE} ${PROJECT_BINARY_DIR}/Doxyfile
    SOURCES ${PROJECT_BINARY_DIR}/Doxyfile
    WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
)

if(WIN32)
    install(
        CODE "execute_process(COMMAND ${CMAKE_BUILD_TOOL} /Build Debug ABIHex.sln /project doc.vcproj
                              WORKING_DIRECTORY \"${CMAKE_CURRENT_BINARY_DIR}\")"
    )
else(WIN32)
    install(
        CODE "execute_process(COMMAND ${CMAKE_BUILD_TOOL} --build --target doc
                              WORKING_DIRECTORY \"${CMAKE_CURRENT_BINARY_DIR}\")"
    )
endif(WIN32)

希望它对某人有用。

问候，
亚历克斯