将git版本信息编译进程序

    有时候我们需要在程序里打印git版本信息，方便源码追踪。有两种方式，一种是通过命令行使用git生成版本信息相关头文件，编译的时候引用这个头文件。另一个种是生成git版本信息宏，源码里直接调用，这里以第二种为例叙说。编译环境使用cmake，在Linux平台，其他环境也可以参照。

    在cmake文件里定义如下:

execute_process(COMMAND	git log -1 --format="%H" WORKING_DIRECTORY ${PROJECT_SOURCE_DIR} OUTPUT_VARIABLE GIT_VERSION)
execute_process(COMMAND	git log -1 --format="%ct" WORKING_DIRECTORY ${PROJECT_SOURCE_DIR} OUTPUT_VARIABLE GIT_TIME)
string (REGEX REPLACE "[\n\t\r\"]" "" GIT_TIME ${GIT_TIME})
execute_process(COMMAND date -d@${GIT_TIME} +"%Y-%m-%d %H:%M:%S" WORKING_DIRECTORY ${PROJECT_SOURCE_DIR} OUTPUT_VARIABLE GIT_DATETIME)
execute_process(COMMAND date +"%Y-%m-%d %H:%M:%S" WORKING_DIRECTORY ${PROJECT_SOURCE_DIR} OUTPUT_VARIABLE BUILD_DATETIME)
# 对得到的结果进行处理，尤其注意 \n,\t,\r之类的特殊字符，在cmake时没问题，但是生成的.cmake文件有问题，导致make出错。
string (REGEX REPLACE "[\n\t\r]" "" GIT_VERSION ${GIT_VERSION})
string (REGEX REPLACE "[\n\t\r]" "" GIT_DATETIME ${GIT_DATETIME})
string (REGEX REPLACE "[\n\t\r]" "" BUILD_DATETIME ${BUILD_DATETIME})
message("git版本:" ${GIT_VERSION} ";  git日期:" ${GIT_DATETIME} ";  编译日期:" ${BUILD_DATETIME})
# 增加编译选项，把宏导入源码
add_definitions( -DGIT_VERSION=${GIT_VERSION})
add_definitions( -DGIT_DATETIME=${GIT_DATETIME})
add_definitions( -DBUILD_DATETIME=${BUILD_DATETIME})

然后就可以在源码中直接打印git版本信息了:

 

 

 

要注意的几点：

1、cmake中的execute_process使用了${PROJECT_SOURCE_DIR}，这个宏要求先定义project(输出程序名称)，不然会导致未定义。

2、add_definitions时网上说需要使用双引号包裹变量，但实际测试时发现不能使用双引号，直接使用变量即可。

3、WORKING_DIRECTORY ${PROJECT_SOURCE_DIR} 中的${PROJECT_SOURCE_DIR}可能需要根据实际情况进行相应的替换，以便能正确获取git相关信息。

4、将整数转换成日期的命令

execute_process(COMMAND date -d@${GIT_TIME} +"%Y-%m-%d %H:%M:%S" WORKING_DIRECTORY ${PROJECT_SOURCE_DIR} OUTPUT_VARIABLE GIT_DATETIME)

会导致程序退出后出现错误：

暂时不知道解决方法，介意的建议不转换，直接打印时间戳