本节介绍如何用CMake来设置软件的版本号

在《一起学习CMake - 01》中我们看到了如何用CMakeLists.txt来构建一个最简单的工程,这一节里我们一起来看看如何用CMake对开发的软件进行版本号的设置。在介绍这方面的内容时,先简单看一下在软件开发中是如何对版本号进行设置的,如VTK 5.6.1,软件当中的版本都表示什么意思。

*******************************************************************************

关于软件版本号的问题
完全的版本号定义,分三项::<主版本号>.<次版本号>.<修订版本号>,如 1.0.0。
版本号升级原则:
主版本号:功能模块有大的变动,比如增加多个模块或者整体架构发生变化。
次版本号:和主版本相对而言,次版本号的升级对应的只是局部的变动。但该局部的变动造成了程序和以前版本不能兼容,或者对该程序以前的协作关系产生了破坏,或者是功能上有大的改进或增强。
修订版本号:局部的变动,主要是局部函数的功能改进,或者bug的修正,或者功能的扩充。
 
1. 各种软件的版本号是怎么确定的,怎样的跨越才能算是由bate到正式版?
原则上,自第一个稳定版本发布后,修订版本号会经常性改动,而次版本号则依情况作改动,主版本号改动的频率很低,除非有大的重构或功能改进。对于小项目而言,甚至可以简化为:>.<次版本号>.<修订版本号>。
版本号比较自由,至于Beta版或者是正式版跟版本号之间并没有任何关系,只要达到正式版的要求的话,即使版本号是1.0或者0.1都可能是正式版的。
* Alpha版: 此版本表示该软件在此阶段主要是以实现软件功能为主,通常只在软件开发者内部交流,一般而言,该版本软件的Bug较多,需要继续修改。
* Beta版: 该版本相对于α版已有了很大的改进,消除了严重的错误,但还是存在着一些缺陷,需要经过多次测试来进一步消除,此版本主要的修改对像是软件的UI。
* RC版: 该版本已经相当成熟了,基本上不存在导致错误的BUG,与即将发行的正式版相差无几。
* Release版: 该版本意味“最终版本”,在前面版本的一系列测试版之后,终归会有一个正式版本,是最终交付用户使用的一个版本。该版本有时也称为标准版。一般情况下,Release不会以单词形式出现在软件封面上,取而代之的是符号(R)。
2. 版本命名规范
软件版本号由四部分组成,第一个1为主版本号,第二个1为子版本号,第三个1为阶段版本号,第四部分为日期版本号加希腊字母版本号,希腊字母版本号共有5种,分别为:base、alpha、beta、RC、release。例如:1.1.1.110108_beta。
3. 版本号定修改规则
* 主版本号(1):当功能模块有较大的变动,比如增加多个模块或者整体架构发生变化。此版本号由项目决定是否修改。
* 子版本号(1):当功能有一定的增加或变化,比如增加了对权限控制、增加自定义视图等功能。此版本号由项目决定是否修改。
* 阶段版本号(1):一般是 Bug 修复或是一些小的变动,要经常发布修订版,时间间隔不限,修复一个严重的bug即可发布一个修订版。此版本号由项目经理决定是否修改。
* 日期版本号(110108):用于记录修改项目的当前日期,每天对项目的修改都需要更改日期版本号。此版本号由开发人员决定是否修改。
* 希腊字母版本号(beta):此版本号用于标注当前版本的软件处于哪个开发阶段,当软件进入到另一个阶段时需要修改此版本号。此版本号由项目决定是否修改。 

*******************************************************************************

详细的关于软件版本号的问题,可以参考百度百科等资料的介绍。下面开始介绍如何用CMake来对自己开发的软件进行版本号的设置。

在第一节所建的目录里,再建立一个空的文件夹:HelloCMake2(在我机子的完整路径是:D:\CMake\CMake-Study\HelloCMake2),然后把HelloCMake里的文件CMakeLists.txt和HelloCMake.cpp两个文件复制到HelloCMake2目录下,打开该目录下的CMakeLists.txt文件,里面的内容应该是:

cmake_minimum_required(VERSION 2.6)

project(HelloCmake)

add_executable(HelloCMake hellocmake.cpp)

接着把它更改为:

cmake_minimum_required(VERSION 2.6)

project(HelloCmake)

# 在CMake里设置HelloCMake软件的主版本号为1,次版本号为0。

set ( HelloCMake_VERSION_MAJOR 1 )

set ( HelloCMake_VERSION_MINOR 0 )

configure_file(

“${PROJECT_SOURCE_DIR}/HelloCMakeConfig.h.in”

“${PROJECT_BINARY_DIR}/HelloCMakeConfig.h”

)

Include_directories (“${PROJECT_BINARY_DIR}”)

add_executable(HelloCMake hellocmake.cpp)

然后在HelloCMake2目录下创建一个文本文件(txt),重命名为”HelloCMakeConfig.h.in”,这里Windows会弹出对话框警告你文件后缀被更改了(原来是***.txt的,现在改为***.in),问题是否继续,点确认更改。

然后用记事本打开HelloCMakeConfig.h.in文件,在里面输入下面的代码:

// the configured options and settings for HelloCMake

#define HelloCMake_VERSION_MAJOR @HelloCMake_VERSION_MAJOR@

#define HelloCMake_VERSION_MINOR @HelloCMake_VERSION_MINOR@

到此为止就完成了用CMake对自己的软件进行版本号设置的一些前期工作,接着打开HelloCMake.cpp文件,把HelloCMakeConfig.h文件包含到该源文件中去,然后在里面加入一些打印HelloCMake软件版本号的信息,看看我们在CMake里设置的版本有没有效果,完整的HelloCMake.cpp代码如下:

#include <iostream>

#include "HelloCMakeConfig.h"

int main(int argc, char *argv[])

{

std::cout<<"HelloCMake软件的主版本号是:"

<< HelloCMake_VERSION_MAJOR << std::endl;

std::cout<<"HelloCMake软件的次版本号是:"

<< HelloCMake_VERSION_MINOR << std::endl;

fprintf(stdout, "%s Version is: %d.%d\n",

argv[0],

HelloCMake_VERSION_MAJOR,

HelloCMake_VERSION_MINOR);

std::cout<<"Study CMake Together - HelloCMake2"<<std::endl;

return 0;

}

打开CMake,根据《一起学习CMake - 01》的流程走一遍CMake。在我机子上我把编译目录设置为:D:\CMake\CMake-Study\HelloCMake2-bin。Configure, Generate完了以后打开HelloCMake2-bin目录下的HelloCMake.sln文件,编译链接,你就会看到整个工程能正确地运行了。

接着我们来看看为什么要这么写,里面的每句代码都表示什么意思。首先看看HelloCMake2目录下的CMakeLists.txt文件,与《一起学习CMake - 01》相比较多了下面的代码:

1. # 在CMake里设置HelloCMake软件的主版本号为1,次版本号为0。

2. set ( HelloCMake_VERSION_MAJOR 1 )

3. set ( HelloCMake_VERSION_MINOR 0 )

4. configure_file(

5.    “${PROJECT_SOURCE_DIR}/HelloCMakeConfig.h.in”

6.    “${PROJECT_BINARY_DIR}/HelloCMakeConfig.h”

7.    )

8. Include_directories (“${PROJECT_BINARY_DIR}”)

第1句,注释作用,在CMake里的注释符号是”#”,这里面的注释已经对第2,3句代码的作用说得很清楚了。”set”是CMake的命令,用于定义变量,即定义了HelloCMake_VERSION_MAJOR和HelloCMake_VERSION_MINOR的值分别为1和0。

第4 – 7句代码,意思就是把” ${PROJECT_SOURCE_DIR}”目录下的文件HelloCMakeConfig.h.in用CMake自动生成后的头文件HelloCMakeConfig.h放到目录“${PROJECT_BINARY_DIR}”。 ” ${PROJECT_SOURCE_DIR}”表示的是工程源文件所在的目录,换句话说就是你在CMake的”where is the source code”里设置的路径;同样”  ${ PROJECT_BINARY_DIR }”就是你在CMake的”where to build the binaries”里设置的路径。这两个变量是CMake里预先定义好的,可以直接拿来用。

第8句代码,意思就是把” ${PROJECT_BINARY_DIR}”路径加入到工程头文件的搜索路径中去,这样工程编译链接时就能够找到HelloCMakeConfig.h这个头文件。因为我们在上面一段已经知道,HelloCMakeConfig.h是CMake根据HelloCMakeConfig.h.in文件自动生成的,并且放在” ${PROJECT_BINARY_DIR}”目录下,所以必须把这个路径加到工程的搜索路径中去。加进去以后你会发现编译环境的变化如下图所示。

< xmlnamespace prefix ="v" ns ="urn:schemas-microsoft-com:vml" />

接着来看看HelloCMake2目录下的文件HelloCMakeConfig.h.in里的内容:

// the configured options and settings for HelloCMake

#define HelloCMake_VERSION_MAJOR @HelloCMake_VERSION_MAJOR@

#define HelloCMake_VERSION_MINOR @HelloCMake_VERSION_MINOR@

很简单,只是定义了两个宏,分别是HelloCMake软件的主版本号和次版本号,”//”这一行当然就表示注释了,你可以打开HelloCMake-bin目录下的自动生成后的HelloCMakeConfig.h文件跟HelloCMakeConfig.h.in文件作一下对比,你会发现它们之前太神似了:

// the configured options and settings for HelloCMake

#define HelloCMake_VERSION_MAJOR 1

#define HelloCMake_VERSION_MINOR 0

“@HelloCMake_VERSION_MAJOR@”和”@HelloCMake_VERSION_MINOR@”是取值的意思,这两个值已经在CMakeLists.txt里定义过了,CMake配置工程时要去CMakeLists.txt读取内容,当它发现set ( HelloCMake_VERSION_MAJOR 1 )和set ( HelloCMake_VERSION_MINOR 0 )这两句代码时,CMake就知道变量HelloCMake_VERSION_MAJOR/ HelloCMake_VERSION_MINOR值分别为1和0。然后结合HelloCMakeConfig.h.in生成了头文件HelloCMakeConfig.h,并用这两个变量替代“@HelloCMake_VERSION_MAJOR@”和”@HelloCMake_VERSION_MINOR@”的值,于是就有了HelloCMakeConfig.h里的内容。

然后我们又在HelloCMake.cpp里包含了头文件”HelloCMakeConfig.h”,也就是定义了HelloCMake_VERSION_MAJOR和HelloCMake_VERSION_MINOR两个宏,接下HelloCMake里就可以肆无忌惮地去引用这两个宏了。

这就是用CMake设置软件版本号的整个过程,上面介绍的过程是我个人的理解,如果有不对的地方一定要告诉我(水灵,MSN:shuiling119@hotmail.com, QQ:348774226)。

再结合VTK, ITK, IGSTK等开源工具包,可以加深你对用CMake进行软件版本号设置的理解,以VTK为例,在VTK的源文件中肯定有一个文件叫做VTKConfigure.h.in(我这里使用的是VTK 5.6.1版本),在该文件的第165-168行,有如下的代码:

/* Version number.  */

#define VTK_MAJOR_VERSION @VTK_MAJOR_VERSION@

#define VTK_MINOR_VERSION @VTK_MINOR_VERSION@

#define VTK_BUILD_VERSION @VTK_BUILD_VERSION@

比较一下跟我们上面提到的HelloCMakeConfig.h.in里的一样吗?

再打开VTK源文件目录下的CMakeLists.txt文件,在第64-67行你会发现有如下代码:

# VTK version number.  An even minor number corresponds to releases.

SET(VTK_MAJOR_VERSION 5)

SET(VTK_MINOR_VERSION 6)

SET(VTK_BUILD_VERSION 1)

再看看这个文件的第1065行开始,有如下代码:

INCLUDE_DIRECTORIES(

${VTK_INCLUDE_DIRS_BUILD_TREE}

${VTK_INCLUDE_DIRS_SOURCE_TREE}

${VTK_INCLUDE_DIRS_BUILD_TREE_CXX}

${VTK_INCLUDE_DIRS_SYSTEM}

)

又比较一下跟我们例子HelloCMake2里的CMakeLists.txt的内容一样吗?

最后再打开VTK的编译目录,你会有里面发现一个文件叫做VTKConfigure.h这个头文件。

用CMake进行软件版本号的设置是不是很简单?只要在CMakeLists.txt里加入一些代码,准备一个YourProjectConfigure.h.in,然后用CMake来构建工程就OK了。

附HelloCMake2程序执行的结果截图:

转自:http://blog.163.com/jacky_ling0/blog/static/13739257120110822137872/

一起学习CMake – 02的更多相关文章

  1. 一起学习CMake – 03

    这一节我们就一起来看看如何用CMake来链接自己写的lib库,如何进行这些库文件的管理. 一个团队共同开发软件时,一般都是分模块进行作业的,每个人负责整个软件中的一部分,然后再整合成一个完整的软件系统 ...

  2. 软件测试之loadrunner学习笔记-02集合点

    loadrunner学习笔记-02集合点 集合点函数可以帮助我们生成有效可控的并发操作.虽然在Controller中多用户负载的Vuser是一起开始运行脚本的,但是由于计算机的串行处理机制,脚本的运行 ...

  3. 机器学习实战(Machine Learning in Action)学习笔记————02.k-邻近算法(KNN)

    机器学习实战(Machine Learning in Action)学习笔记————02.k-邻近算法(KNN) 关键字:邻近算法(kNN: k Nearest Neighbors).python.源 ...

  4. OpenCV 学习笔记 02 使用opencv处理图像

    1 不同色彩空间的转换 opencv 中有数百种关于不同色彩空间的转换方法,但常用的有三种色彩空间:灰度.BRG.HSV(Hue-Saturation-Value) 灰度 - 灰度色彩空间是通过去除彩 ...

  5. [eShopOnContainers 学习系列] - 02 - vs 2017 开发环境配置

    [eShopOnContainers 学习系列] - 02 - vs 2017 开发环境配置 https://github.com/dotnet-architecture/eShopOnContain ...

  6. 一起学习CMake – 01

    一起学习CMake – 01 本节介绍CMake里最常用的三个命令,分别是cmake_minimum_required; project; add_executable等. CMake是个好东西,在使 ...

  7. SaToken学习笔记-02

    SaToken学习笔记-02 如果排版有问题,请点击:传送门 常用的登录有关的方法 - StpUtil.logout() 作用为:当前会话注销登录 调用此方法,其实做了哪些操作呢,我们来一起看一下源码 ...

  8. Redis:学习笔记-02

    Redis:学习笔记-02 该部分内容,参考了 bilibili 上讲解 Redis 中,观看数最多的课程 Redis最新超详细版教程通俗易懂,来自 UP主 遇见狂神说 4. 事物 Redis 事务本 ...

  9. OGG学习笔记02

    实验环境:源端:192.168.1.30,Oracle 10.2.0.5 单实例目标端:192.168.1.31,Oracle 10.2.0.5 单实例 1.模拟源数据库业务持续运行 2.配置OGG前 ...

随机推荐

  1. Nginx CORS实现JS跨域

    1. 什么是跨域 简单地理解就是因为JavaScript同源策略的限制,a.com 域名下的js无法操作b.com或是c.a.com域名下的对象. 同源是指相同的协议.域名.端口.特别注意两点: 如果 ...

  2. HDU 1498 50 years, 50 colors

    题目大意:给你一个 n*n 的矩阵,每个格子上对应着相应颜色的气球,每次你可以选择一行或一列的同种颜色的气球进行踩破,问你在K次这样的操作后,哪些颜色的气球是不可能被踩破完的. 题解:对于每一种颜色建 ...

  3. Android多线程及异步处理问题

    1.问题提出 1)为何需要多线程? 2)多线程如何实现? 3)多线程机制的核心是啥? 4)到底有多少种实现方式? 2.问题分析 1)究其为啥需要多线程的本质就是异步处理,直观一点说就是不要让用户感觉到 ...

  4. ExtJs 4 的filefield上传后 返回值success接受不正常

    问题解决了,我修改了返回类型为setContentType("text/html")可以正确解析了,感到很奇怪,其他的地方使用setContentType("applic ...

  5. SqlServer之like、charindex、patindex(转载)

    SqlServer之like.charindex.patindex   1.环境介绍 测试环境 SQL2005 测试数据 200W条   2.环境准备 2.1建表 CREATE TABLE [dbo] ...

  6. tomcat配置没啥难的啊

    总体上就是: 1.下载jdk并安装. 2.下载tomcat 3.分别设置好环境变量. 4.cmd java -version 如果成功,证明java jdk配置OK startup.bat 如果成功 ...

  7. JAVA虚拟机内存模型

    一.对于Java程序员来说,在虚拟机的自动内存管理机制下,我们不需要为每一个new操作去写匹配的delete/free操作 但是当我们对于内存的管理了解有能够帮助我们理解Java虚拟机的垃圾回收机制. ...

  8. JavaSE学习总结第06天_Java语言基础2 & 面向对象1

      06.01 二维数组概述和格式1的讲解 二维数组概述:二维数组其实就是一个元素为一维数组的数组 格式1:数据类型[][] 变量名 = new 数据类型[m][n]; m表示这个二维数组有多少个一维 ...

  9. hadoop序列化机制与java序列化机制对比

    1.采用的方法: java序列化机制采用的ObjectOutputStream 对象上调用writeObject() 方法: Hadoop 序列化机制调用对象的write() 方法,带一个DataOu ...

  10. asp.net mvc 客户端(&)中检测到有潜在危险的 Request.Path 值。

    出现这个错误后,试过 <pages validateRequest="false"> <httpRuntime requestValidationMode=&qu ...