CMake在源码目录创建符号链接失败问题咨询

核心结论 #

CMake没有禁止在源码目录创建符号链接，你的问题出在自定义目标的执行时机和命令逻辑上。

问题原因分析 #

1. 执行时机不对：你使用的add_custom_target定义的目标默认在构建阶段执行（比如运行make/ninja时），而非CMake配置阶段（执行cmake ..的阶段）。所以配置阶段看不到符号链接是正常行为，只有触发构建命令后才会生成。
2. 路径逻辑无问题：你用绝对路径${CMAKE_CURRENT_SOURCE_DIR}指定文件位置，即使CMake默认工作目录是构建目录，命令也能定位到正确文件。手动执行命令成功是因为你直接在源码目录触发了命令，跳过了构建阶段的等待流程。

解决方案 #

方案1：在配置阶段生成符号链接 #

如果需要在cmake配置时就生成链接，改用execute_process（CMake配置阶段直接执行命令）：

execute_process(
    COMMAND ${CMAKE_COMMAND} -E create_symlink
        ${CMAKE_CURRENT_SOURCE_DIR}/file.cpp
        ${CMAKE_CURRENT_SOURCE_DIR}/noopt/file-noopt.cpp
    RESULT_VARIABLE symlink_result
    ERROR_VARIABLE symlink_error
)
# 可选：添加错误提示
if(NOT symlink_result EQUAL 0)
    message(WARNING "创建符号链接失败：${symlink_error}")
endif()

方案2：保持构建阶段生成（原逻辑调整） #

如果仍希望在构建阶段生成，确保执行构建命令（比如make SwapPerfSymlink或直接make，因为你加了ALL参数），也可以显式指定工作目录（虽绝对路径下无需此操作，但逻辑更清晰）：

add_custom_target(
    SwapPerfSymlink ALL
    COMMAND ${CMAKE_COMMAND} -E create_symlink
        ${CMAKE_CURRENT_SOURCE_DIR}/file.cpp
        ${CMAKE_CURRENT_SOURCE_DIR}/noopt/file-noopt.cpp
    WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
)

注意事项 #

• 源码目录通常受版本控制（如Git）管理，直接在源码目录创建符号链接可能带来跨平台兼容性问题（比如Windows需要管理员权限才能创建符号链接），更推荐在构建目录生成链接，避免污染源码树。
• 确保符号链接的目标目录（如${CMAKE_CURRENT_SOURCE_DIR}/noopt）已提前创建，否则命令会执行失败。

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