利用Cmake展示Git内容的方法

2023 年 11 月 01 日

271 次浏览

1475字数

在编程世界中，CMake和Git都是非常重要的工具。CMake是一个跨平台的构建（编译）系统，它可以用简单的语句来描述所有平台的构建信息，使得编写跨平台的Makefile变得简单。而Git是一个分布式版本控制系统，用于敏捷高效地处理任何大小的项目。

那么，如何利用CMake展示Git内容呢？这里我们将通过一个简单的例子来说明。我们将创建一个CMake项目，该项目将获取Git仓库的信息，并在构建时将其打印出来。

首先，我们需要在CMakeLists.txt文件中添加以下内容：

project(GitInfo)

# 查找Git
find_package(Git)
if(GIT_FOUND)
    message("Git found: ${GIT_EXECUTABLE}")
endif()

# 获取Git版本信息
list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake")
include(GetGitRevisionDescription)
get_git_head_revision(GIT_REFSPEC GIT_SHA1)

# 将Git版本信息添加到编译定义中
add_definitions("-DGIT_REFSPEC=\"${GIT_REFSPEC}\"")
add_definitions("-DGIT_SHA1=\"${GIT_SHA1}\"")

这段代码首先查找Git，然后使用一个名为GetGitRevisionDescription的模块来获取Git版本信息。这个模块不是CMake自带的，我们需要自己创建。

在cmake目录下创建一个名为GetGitRevisionDescription.cmake的文件，内容如下：

macro(get_git_head_revision refspec sha1)
  execute_process(
    COMMAND ${GIT_EXECUTABLE} rev-parse --short HEAD
    WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"
    OUTPUT_VARIABLE sha1
    OUTPUT_STRIP_TRAILING_WHITESPACE
  )
  execute_process(
    COMMAND ${GIT_EXECUTABLE} name-rev --name-only HEAD
    WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"
    OUTPUT_VARIABLE refspec
    OUTPUT_STRIP_TRAILING_WHITESPACE
  )
endmacro()

这个宏会执行Git命令来获取当前的引用和SHA1哈希值。

然后，我们在主程序中打印这些信息。例如，如果我们的主程序是一个C++程序，那么我们可以这样写：

#include <iostream>

int main() {
    std::cout << "Git branch: " << GIT_REFSPEC << std::endl;
    std::cout << "Git commit hash: " << GIT_SHA1 << std::endl;
    return 0;
}

这样，每次构建项目时，都会打印出当前的Git分支和提交哈希值。

这只是一个基本的例子，实际上，你可以获取更多的Git信息，例如标签、提交者信息等。你也可以将这些信息用于其他目的，例如生成版本号、添加到日志中等。

总的来说，CMake和Git是强大的工具，通过合理的使用，可以极大地提高开发效率。