CMake怎么自动生成带有版本号信息的Version.h

阿明酱_2739

阿明酱_2739

2026-09-30

239人浏览

原创

configure_file在cmake配置阶段将version.h.in转换为version.h:扫描@var@占位符,用同名cmake变量值替换,生成文件至构建目录,并需通过target_include_directories将其加入头文件搜索路径。

cmake怎么自动生成带有版本号信息的version.h

configure_file 是怎么把 version.h.in 变成 version.h 的

它不是编译时运行,而是在 cmake 配置阶段(即你执行 cmake .. 时)就完成变量替换。CMake 会扫描模板文件中所有 @VAR@ 形式的占位符,用当前作用域中同名 CMake 变量的值去替换——注意,只认 @ 包裹的写法,${VAR} 在 configure_file 中默认不生效(除非加 @ONLY 参数且变量已定义)。

常见错误现象:

  • 生成的 version.h 里还留着 @VERSION@ ——说明 VERSION 变量没在 configure_file 前定义,或拼写不一致
  • 头文件被生成到源码目录而非构建目录——导致 Git 脏、多构建目录冲突;正确路径应是 ${CMAKE_CURRENT_BINARY_DIR}/version.h
  • 修改了 version.h.in 但重新 cmake 后没更新——因为 CMake 认为输入没变,需手动删 CMakeCache.txt 或用 cmake -P 强制重跑

如何让 VERSION 变量支持命令行传入(比如 cmake -DVERSION=2.1.0 ..)

直接用 set(VERSION "1.0.0" CACHE STRING "Project version"),这样用户就能通过 -DVERSION=... 覆盖默认值。配合 configure_file 就能动态生效。

使用场景:

  • CI/CD 流水线中用 Git tag 自动设版本:cmake -DVERSION=$(git describe --tags) ..
  • 本地调试时快速切版本:cmake -DVERSION=dev-$(date +%s) ..
  • 区分 release/debug 构建:if(CMAKE_BUILD_TYPE STREQUAL "Debug") set(VERSION "${VERSION}-debug")

注意:如果没加 CACHE,-D 传参会被忽略;如果加了但没给默认值,首次运行会报错提示缺失。

为什么 version.h 必须用 target_include_directories 加入头搜索路径

configure_file 生成的 version.h 默认在构建目录(如 build/),而源码里 #include "version.h" 默认只搜源码目录和显式指定的路径。不加 target_include_directories,编译器根本找不到它。

CMake 4.3.2
CMake 4.3.2

CMake 4.3.2 Windows x86_64 历史版本安装包,适合旧项目兼容、构建环境回退、CMakeLists.txt 迁移验证、Visual Studio/Ninja/Makefile 生成器测试和 C/C++ 项目维护。

下载

关键参数差异:

  • PRIVATE:仅该 target 内部可用,不影响依赖它的其他 target
  • PUBLIC:该 target 和所有链接它的 target 都能用——适合库项目暴露版本接口
  • 路径必须用 ${CMAKE_CURRENT_BINARY_DIR},不能写死 ./build/version.h,否则跨平台或 out-of-source 构建失败

Git 提交哈希和编译时间怎么塞进 version.h

用 execute_process 调 git 命令获取哈希,用 string(TIMESTAMP) 获取时间,再统一注入变量:

string(TIMESTAMP BUILD_TIME "%Y-%m-%d %H:%M:%S")
execute_process(COMMAND git rev-parse --short HEAD
  WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
  OUTPUT_VARIABLE GIT_COMMIT
  OUTPUT_STRIP_TRAILING_WHITESPACE)
set(GIT_COMMIT "${GIT_COMMIT}")
configure_file(version.h.in ${CMAKE_CURRENT_BINARY_DIR}/version.h)

模板 version.h.in 中写:

#define BUILD_TIME "@BUILD_TIME@"
#define GIT_COMMIT "@GIT_COMMIT@"

容易踩的坑:

  • 没装 Git 或不在 Git 仓库里运行 cmake → execute_process 失败,GIT_COMMIT 为空;建议加 RESULT_VARIABLE 判断并 fallback
  • Windows 上 git 命令可能不在 PATH,需用 find_program(GIT git) 先定位
  • 时间戳用 UTC 参数避免时区混乱:string(TIMESTAMP BUILD_TIME "%Y-%m-%d %H:%M:%S" UTC)

最常被忽略的是:version.h 一旦生成,后续 make 或 ninja 不会自动重生成——哪怕你改了 Git 分支或系统时间。真要每次编译都刷新,得用自定义命令 + add_custom_target 驱动,而不是依赖 configure_file。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

cmake

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
C++ 跨平台开发
C++ 跨平台开发

本专题聚焦 C++ 在跨平台应用与工程构建中的实战应用,系统讲解 CMake 构建系统、跨平台编译配置、第三方库集成、调试技巧、静态与动态链接库管理等核心知识。通过实战案例(如跨平台工具开发、Linux与Windows编译兼容性项目),帮助学习者掌握 从环境配置到完整跨平台构建的开发能力。

2025.10.17

5666

15

c++  cmake用法
c++ cmake用法

本专题整合了c++ cmake用法相关教程,阅读专题下面的文章了解更多详细内容。

2025.10.23

1451

14

C++ 编译构建系统与CMake实战
C++ 编译构建系统与CMake实战

本专题聚焦 C++ 项目的编译与构建体系,系统讲解 CMake 的核心语法、项目结构设计、库与依赖管理、跨平台构建、调试与发布配置。通过完整项目示例,帮助开发者掌握 从源码到可执行程序的工程化构建流程,提升 C++ 项目在实际开发中的可维护性与扩展性。

2025.12.13

334

18

PDF转图片方法
PDF转图片方法

需要把 PDF 页面用于上传、预览、分享或图片归档时,PDF 转图片方法专题整理 JPG/PNG 格式选择、逐页导出、清晰度设置、批量下载和结果检查等流程,帮助用户稳定完成 PDF 图片化处理。

2026.09.30

0

26

PixTV AI视频生成与无限画布创作
PixTV AI视频生成与无限画布创作

PixTV专题整理AI视频与视觉内容创作相关功能使用教程,涵盖AI生图、视频生成、无限画布、多模型创作、素材管理、声音音乐及视频剪辑等功能,帮助用户快速掌握PixTV从创意到成片的完整制作方法。

2026.09.29

0

15

Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

2026.09.23

200

15

Buffalo框架路由与请求处理实操指南
Buffalo框架路由与请求处理实操指南

本专题讲解Buffalo框架路由与请求处理机制,涵盖路由注册与分组、资源路由、Handler编写规范、Context上下文方法、参数绑定、中间件编写挂载、Session与Cookie读写、Flash消息及错误页面定制方法。

2026.09.23

120

15

Buffalo框架零基础入门教程
Buffalo框架零基础入门教程

本专题整理Buffalo框架入门内容,涵盖Go环境准备、buffalo CLI安装、新项目生成、目录结构说明、dev热加载启动、数据库连接配置与常见报错排查,帮助新手按约定优于配置的思路跑通第一个Buffalo框架应用。

2026.09.23

100

15

Conan创建软件包配方指南
Conan创建软件包配方指南

本专题介绍通过conanfile.py创建软件包的方法,讲解包名、版本、依赖和构建设置等基础信息,以及source、build、package、package_info等常用方法的作用及编写思路。

2026.09.22

60

12

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
CMake 与 Conan 集成实践
CMake 与 Conan 集成实践

共0课时 | 0人学习

Conan 2 入门教程
Conan 2 入门教程

共0课时 | 0人学习

CLion CMake 快速入门教程
CLion CMake 快速入门教程

共0课时 | 0人学习