CMake常用命令（一） cmake_minimum_required

---

CMake使用注意事项

1. CMakeLists.txt 文件名严格区分大小写
2. CMake指令可以不区分大小写，大小写混写都行，每条语句不需要加分号；
3. 参数严格区分大小写，名称只能用字母、数字、下划线、破折号
4. 使用${}来引用 ， 参数之间使用空格分割
5. 使用 # 可以做注释

语法

cmake_minimum_required(VERSION <min>[...<max>] [FATAL_ERROR])
1

作用

该命令指明了对cmake的最低(高)版本的要求，…为低版本和高版本之间的连接符号，没有其他含义。

参数

cmake版本号说明

cmake的版本号格式为major.minor[.patch[.tweak]]，例如cmake的版本号为3.10.2。

参数

1. VERSION：指明后面的参数为版本号，这个参数是必须的。
2. min：指定cmake要求的最低版本号，如果cmake实际版本号低于min指定的版本号，cmake的执行过程会终止。
3. max：指定cmake要求的最高版本号，要求该参数不能小于min。如果cmake是3.12之前的版本，…会被忽略，按照min指定的版本参数运行，相当于cmake_minimum_required(VERSION …3.12)。
4. FATAL_ERROR： 该参数在cmake的2.6及以后的版本被忽略，在cmake的2.4及以前的版本，需要指明该参数，以便cmake能提示失败而不仅仅是一个警告。

举例

假设当前系统的cmake版本为3.10.2

示例1 指定了min

cmake_minimum_required (VERSION 3.12.0)
1

示例2 指定了min,也指定了max，实际上由于当前环境的cmake版本低于3.12，因此…max是会被忽略的

cmake_minimum_required (VERSION 3.10.0...3.12.0)
1

更多细节

cmake_minimum_required命令要求放在顶层的CMakeLists.txt文件的最开始，在其他命令执行前调用，这是因为后续的命令的行为表现可能跟版本有关系。

如果在函数内调用cmake_minimum_required，那么这个命令只在函数内起作用

cmake_minimum_required命令的实质是指定了当前工程支持的cmake版本范围，它暗含对cmake_policy的调用，而cmake_policy指定了cmake版本的策略机制，主要是为了保障在不同的cmake版本间的兼容性。

1. cmake的策略机制是为了保证，即使新cmake版本引入变化（新功能或者功能点变更），当前工程的构建仍然可以被兼容。
2. 每一种新的策略机制（cmake版本更新带来的变化）用形如CMP来标识，其中NNNN是一个整数，每一种的策略机制有NEW和OLD两种行为表现，调用方式为cmake_policy(SET CMP OLD)或cmake_policy(SET CMP NEW)。例如策略CMP0000为“必须指定cmake要求的最低版本”，该策略在2.6版本引入，并且不建议使用OLD行为，后续版本会考虑对该策略移除OLD行为；策略CMP0002为“逻辑目标名称必须全局唯一（逻辑目标名称即被add_executable()、add_library()、add_custom_target()创建的名称)”，该策略在2.6版本引入，并且不建议使用OLD行为，后续版本会考虑对该策略移除OLD行为。
3. 对于当前运行cmake版本已知的所有策略，若是在min（或max：运行的cmake高于max时）以及min之前版本引入的，都会被设置为NEW行为，在min之后版本引入的策略，行为不会被设置，需要显式指定（调用cmake_policy或者CMAKE_POLICY_DEFAULT_CMP）。假设运行的cmake版本为3.18.2，min是3.12.2，max是3.13.2，可以看到max小于当前运行的cmake版本(3.13.2<3.18.2)，因此3.13.2之前的策略的模型行为是NEW（CMP0081 = NEW），而3.13.2之后的策略默认为空（CMP0108 =）：

 # CMakeLists.txt文件
 cmake_minimum_required (VERSION 3.12.2...3.16.2)

 cmake_policy (GET CMP0108 cmp_0108)# CMP0108为cmake 3.18引入的
 message (">>> cmp0108 = ${cmp_0108}")

 cmake_policy (GET CMP0081 cmp_0081) # CMP0081为cmake 3.13引入的
 message (">>> cmp0081 = ${cmp_0081}")
1
2
3
4
5
6
7
8

参考

Cmake命令之cmake_minimum_required介绍
CMAKE官方介绍