CMake自定义文档目标安装报错：解决非可执行目标无法安装问题

install(TARGETS)仅支持安装可执行文件、库、模块等特定类型的目标，而add_custom_target创建的是实用工具（UTILITY）目标，不在该命令的支持范围内，因此触发报错。

方案一：直接安装生成的PDF文件（兼容性好） #

修改add_doc函数，将生成的PDF文件路径暴露给父作用域，让用户通过install(FILES)完成安装：

修改后的函数实现 #

function(add_doc DOCNAME)
  set(TEXFILE ${CMAKE_CURRENT_SOURCE_DIR}/${DOCNAME}.tex)
  set(PDFFILE ${CMAKE_CURRENT_BINARY_DIR}/${DOCNAME}.pdf)

  find_program(LATEXMK latexmk REQUIRED)
  add_custom_target( ${DOCNAME} ALL
    COMMAND ${LATEXMK} -silent -outdir=${CMAKE_CURRENT_BINARY_DIR} ${TEXFILE}
    WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
    BYPRODUCTS "${PDFFILE}"
    COMMENT "Building ${DOCNAME}"
    VERBATIM
  )

  # 将PDF路径暴露给父作用域，方便用户引用
  set(${DOCNAME}_PDF ${PDFFILE} PARENT_SCOPE)
endfunction()

用户调用示例 #

add_doc(docname)
# 自行指定安装路径和组件
install(FILES ${docname_PDF} DESTINATION ${CMAKE_INSTALL_DOCDIR} COMPONENTS doc)

方案二：用INTERFACE库适配install(TARGETS)语法 #

如果坚持要使用install(TARGETS)的调用方式，可以通过创建INTERFACE库目标（CMake支持安装该类型）来关联生成的PDF文件：

修改后的函数实现 #

function(add_doc DOCNAME)
  set(TEXFILE ${CMAKE_CURRENT_SOURCE_DIR}/${DOCNAME}.tex)
  set(PDFFILE ${CMAKE_CURRENT_BINARY_DIR}/${DOCNAME}.pdf)

  find_program(LATEXMK latexmk REQUIRED)
  # 先定义生成PDF的自定义命令
  add_custom_command(
    OUTPUT "${PDFFILE}"
    COMMAND ${LATEXMK} -silent -outdir=${CMAKE_CURRENT_BINARY_DIR} ${TEXFILE}
    WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
    MAIN_DEPENDENCY ${TEXFILE}
    COMMENT "Building ${DOCNAME}"
    VERBATIM
  )

  # 创建INTERFACE库目标，用于被install(TARGETS)识别
  add_library(${DOCNAME} INTERFACE)
  # 关联PDF文件，确保构建顺序正确
  target_sources(${DOCNAME} INTERFACE "${PDFFILE}")
endfunction()

用户调用示例 #

add_doc(docname)
# 直接用install(TARGETS)指定参数
install(TARGETS docname DESTINATION ${CMAKE_INSTALL_DOCDIR} COMPONENTS doc)

注：方案二建议使用CMake 3.14及以上版本，以保证INTERFACE库安装逻辑的兼容性。

内容的提问来源于stack exchange，提问作者Stewart