【CMake】顶层 CMakeList.txt 常用命令总结

文章目录

1. cmake_minimum_required
- 1.1. 简介
- 1.2. 使用案例
- - 1.2.1. 执行构建的cmake版本低于`<min>`
  - 1.2.2. 设置`<policy_max>`
  - - 1.2.2.1. `<policy_max>`低于`<min>`
    - 1.2.2.2. `<policy_max>`大于等于`<min>`

1. cmake_minimum_required

1.1. 简介

功能：为项目设置cmake的最低要求版本
常用程度：⭐⭐⭐⭐⭐
命令格式

cmake_minimum_required(VERSION <min>[...<policy_max>] [FATAL_ERROR])

命令详解
- <min>和<policy_max>的格式：major.minor[.patch[.tweak]]
  - major：主版本号
  - minor：次版本号
  - patch：补丁版本号
  - tweak：微调版本号
- 如果执行构建的cmake版本低于<min>，项目构建会停止并且会报告错误
- <policy_max>如果指定，必须至少为<min>，影响策略设置。

1.2. 使用案例

Windows终端查看cmake版本

cmake --version

输出当前版本号为3.28.3：

D:\Test\projectX\build>cmake --version
cmake version 3.28.3CMake suite maintained and supported by Kitware (kitware.com/cmake).

1.2.1. 执行构建的cmake版本低于`<min>`

CMakeLists.txt中的内容
```
cmake_minimum_required(VERSION 3.30)
```

执行cmake构建命令后的输出：

-- Selecting Windows SDK version 10.0.19041.0 
to target Windows 10.0.19045.
CMake Error at CMakeLists.txt:1 (cmake_minimum_required):CMake 3.30 or higher is required.  You are running version 3.28.3-- Configuring incomplete, errors occurred!

1.2.2. 设置`<policy_max>`

1.2.2.1. `<policy_max>`低于`<min>`

CMakeLists.txt中的内容

cmake_minimum_required(VERSION 3.26...3.25)

执行cmake构建命令后的输出

-- Selecting Windows SDK version 10.0.19041.0 to target Windows 10.0.19045.
CMake Error at CMakeLists.txt:1 (cmake_minimum_required):Policy VERSION range "3.26...3.25" specifies a larger minimum than maximum.-- Configuring incomplete, errors occurred!

1.2.2.2. `<policy_max>`大于等于`<min>`

CMakeLists.txt中的内容

cmake_minimum_required(VERSION 3.26...3.26)

执行cmake构建命令后的输出

-- Selecting Windows SDK version 10.0.19041.0 to target Windows 10.0.19045.
-- Configuring done (0.0s)
-- Generating done (0.0s)
-- Build files have been written to: D:/Test/projectX/build