在custom_target中执行git describe

Question

我想将git describe字符串的输出写入文件，以便可以将信息嵌入到二进制文件（C ++）中。这必须跨平台工作。

我能想到的最好的方法是：

add_custom_target( SubmarineGitVersion
    COMMAND cmd /c "${CMAKE_EXECUTABLE}" echo czstring GIT_VERSION = STRINGIFY\( > "${CMAKE_CURRENT_BINARY_DIR}/GitVersion.hpp"
    COMMAND cmd /c "${GIT_EXECUTABLE}" describe --tags --always >> "${CMAKE_CURRENT_BINARY_DIR}/GitVersion.hpp"
    COMMAND cmd /c "${CMAKE_EXECUTABLE}" echo \) >> "${CMAKE_CURRENT_BINARY_DIR}/GitVersion.hpp"
)

这在Windows上大致适用（;末尾缺少a ）：

czstring GIT_VERSION = STRINGIFY(
tag-343434
)

有没有更好/更多的跨平台方法？

Answer 1

创建“版本”文件的常用方法是使用configure_file命令。这样的方式文件将在配置阶段创建：

GitVersion.hpp.in：

czstring GIT_VERSION = STRINGIFY(
${GIT_REPO_VERSION}
)

CMakeLists.txt：

# Store version into variable
execute_process(COMMAND ${GIT_EXECUTABLE} describe --tags --always
    OUTPUT_VARIABLE GIT_REPO_VERSION)
# The variable will be used when file is configured
configure_file("GitVersion.hpp.in" "GitVersion.hpp")

如果要在构建阶段创建版本文件，请在cmake命令上方移至某个文件，然后以CMake脚本模式执行此文件：

generate_version.cmake：

# Git executable is extracted from parameters.
execute_process(COMMAND ${GIT_EXECUTABLE} describe --tags --always
    OUTPUT_VARIABLE GIT_REPO_VERSION)
# Input and output files are extracted from parameters.
configure_file(${INPUT_FILE} ${OUTPUT_FILE})

CMakeLists.txt：

add_custom_target( SubmarineGitVersion
    COMMAND ${CMAKE_COMMAND}
        -D GIT_EXECUTABLE=${GIT_EXECUTABLE}
        -D INPUT_FILE=${CMAKE_CURRENT_SOURCE_DIR}/GitVersion.hpp.in
        -D OUTPUT_FILE=${CMAKE_CURRENT_BINARY_DIR}/GitVersion.hpp
        -P ${CMAKE_CURRENT_SOURCE_DIR}/generate_version.cmake
)