cmake-policies(7)¶
简介¶
CMake 策略引入了行为变更,同时为现有项目版本保留了兼容性。策略是弃用机制,而不是功能开关。每个策略都记录了已弃用的 OLD
行为和首选的 NEW
行为。项目必须随着时间更新以使用 NEW
行为,但其现有版本将继续使用 OLD
行为。
更新项目¶
当某个版本的 CMake 新引入策略时,该版本及更高版本会立即弃用其 OLD
行为。项目应尽快更新以使用策略的 NEW
行为。
使用 cmake_minimum_required()
命令记录项目已更新到的最新 CMake 版本。例如
cmake_minimum_required(VERSION 3.10...4.0)
这使用 <min>...<max>
语法来启用 CMake 4.0 及更早版本中引入的策略的 NEW
行为,同时只要求最低版本为 CMake 3.10。项目应在使用这些版本之间引入的策略的 OLD
行为和 NEW
行为时都能正常工作。
过渡计划¶
为了帮助项目按照自己的时间表移植到策略的 NEW
行为,CMake 提供了一个过渡期
如果项目未设置策略,CMake 将使用其
OLD
行为,但可能会警告策略未设置。运行 CMake 的用户可以通过在
cmake(1)
命令行上将CMAKE_POLICY_DEFAULT_CMP<NNNN>
变量设置为缓存条目来静默警告,而无需修改项目cmake -DCMAKE_POLICY_DEFAULT_CMP0990=OLD ...
项目可以通过使用
cmake_policy()
命令显式将策略设置为OLD
或NEW
行为来静默警告if(POLICY CMP0990) cmake_policy(SET CMP0990 NEW) endif()
注意
策略几乎不应设置为
OLD
,除非是为了在已冻结或稳定的代码库中静默警告,或作为更大迁移路径的一部分临时设置。
如果策略被项目设置为
OLD
,则在引入策略的版本发布至少 2 年后发布的 CMake 版本可能会发出警告,指出该策略的OLD
行为将从未来版本的 CMake 中移除。如果策略未被项目设置为
NEW
,则在引入策略的版本发布至少 6 年后发布且主要版本号更高的 CMake 版本可能会发出错误,指出该策略的OLD
行为已被移除。
支持的策略¶
支持以下策略。
CMake 4.1 引入的策略¶
- CMP0197: MSVC 链接 -machine: 标志不在 CMAKE_*_LINKER_FLAGS 中。
- CMP0196: CMakeDetermineVSServicePack 模块已移除。
- CMP0195: 构建树中的 Swift 模块使用 Swift 模块目录结构。
- CMP0194: MSVC 不是 ASM 语言的汇编器。
- CMP0193: GNUInstallDirs 为安装前缀 '/' 缓存 CMAKE_INSTALL_*,前缀为 'usr/'。
- CMP0192: GNUInstallDirs 在特殊前缀中使用绝对路径 SYSCONFDIR、LOCALSTATEDIR 和 RUNSTATEDIR。
- CMP0191: FindCABLE 模块已移除。
- CMP0190: FindPython 在交叉编译模式下强制保持一致性。
- CMP0189: TARGET_PROPERTY 传递性评估 LINK_LIBRARIES 属性。
- CMP0188: FindGCCXML 模块已移除。
- CMP0187: 在同名但带扩展名的源文件后包含不带扩展名的源文件。
- CMP0186: 正则表达式在重复搜索中最多匹配一次 ^。
CMake 4.0 引入的策略¶
CMake 3.31 引入的策略¶
- CMP0180: project() 总是将
_* 设置为普通变量。 - CMP0179: 链接行上静态库的重复删除保留第一次出现。
- CMP0178: 测试命令行保留空参数。
- CMP0177: install() DESTINATION 路径被规范化。
- CMP0176: execute_process() ENCODING 默认为 UTF-8。
- CMP0175: add_custom_command() 拒绝无效参数。
- CMP0174: cmake_parse_arguments(PARSE_ARGV) 为单值关键字后的空字符串定义一个变量。
- CMP0173: CMakeFindFrameworks 模块已移除。
- CMP0172: CPack 模块在 CPack WIX Generator 中默认启用每台机器安装。
- CMP0171: 'codegen' 是一个保留的目标名称。
CMake 3.30 引入的策略¶
- CMP0170: FETCHCONTENT_FULLY_DISCONNECTED 要求得到强制执行。
- CMP0169: FetchContent_Populate(depName) 单参数签名已弃用。
- CMP0168: FetchContent 直接执行步骤而不是通过子构建。
- CMP0167: FindBoost 模块已移除。
- CMP0166: TARGET_PROPERTY 传递性评估静态库的私有依赖项上的链接属性。
- CMP0165: enable_language() 不得在 project() 之前调用。
- CMP0164: add_library() 在平台不支持时拒绝 SHARED 库。
- CMP0163: GENERATED 源文件属性现在在所有目录中都可见。
- CMP0162: Visual Studio 生成器默认添加 UseDebugLibraries 指示符。
CMake 3.29 引入的策略¶
CMake 3.28 引入的策略¶
CMake 3.27 引入的策略¶
- CMP0151: AUTOMOC 包含目录默认是系统包含目录。
- CMP0150: ExternalProject_Add 和 FetchContent_Declare 将相对 Git 仓库路径视为相对于父项目的远程路径。
- CMP0149: Visual Studio 生成器默认选择最新的 Windows SDK。
- CMP0148: FindPythonInterp 和 FindPythonLibs 模块已移除。
- CMP0147: Visual Studio 生成器并行构建自定义命令。
- CMP0146: FindCUDA 模块已移除。
- CMP0145: Dart 和 FindDart 模块已移除。
- CMP0144: find_package 使用大写 PACKAGENAME_ROOT 变量。
CMake 3.26 引入的策略¶
CMake 3.25 引入的策略¶
CMake 3.24 引入的策略¶
- CMP0139: if() 命令支持使用 PATH_EQUAL 运算符进行路径比较。
- CMP0138: CheckIPOSupported 使用调用项目的标志。
- CMP0137: try_compile() 在项目模式下传递平台变量。
- CMP0136: Watcom 运行时库标志由抽象选择。
- CMP0135: ExternalProject 和 FetchContent 默认情况下忽略 URL 下载方法的归档文件中的时间戳。
- CMP0134: 当“TARGET”视图不可用时,回退到“HOST”Windows 注册表视图。
- CMP0133: CPack 模块在 CPack DragNDrop Generator 中默认禁用 SLA。
- CMP0132: 首次运行时不设置编译器环境变量。
- CMP0131: LINK_LIBRARIES 支持 LINK_ONLY 生成器表达式。
- CMP0130: while() 诊断条件评估错误。
CMake 3.23 引入的策略¶
CMake 3.22 引入的策略¶
CMake 3.21 引入的策略¶
CMake 3.20 引入的策略¶
CMake 3.19 引入的策略¶
CMake 3.18 引入的策略¶
CMake 3.17 引入的策略¶
CMake 3.16 引入的策略¶
CMake 3.15 引入的策略¶
CMake 3.14 引入的策略¶
- CMP0088: FindBISON 在执行时在 CMAKE_CURRENT_BINARY_DIR 中运行 bison。
- CMP0087: install(SCRIPT | CODE) 支持生成器表达式。
- CMP0086: UseSWIG 通过 -module 标志遵守 SWIG_MODULE_NAME。
- CMP0085: IN_LIST 生成器表达式处理空列表项。
- CMP0084: FindQt 模块不存在于 find_package() 中。
- CMP0083: 链接可执行文件时添加 PIE 选项。
- CMP0082: add_subdirectory() 中的安装规则与调用方中的安装规则交错。
CMake 3.13 引入的策略¶
CMake 3.12 引入的策略¶
CMake 3.11 引入的策略¶
CMake 3.10 引入的策略¶
CMake 3.9 引入的策略¶
CMake 3.8 引入的策略¶
CMake 3.7 引入的策略¶
不支持的策略¶
以下策略不再受支持。项目对 cmake_minimum_required(VERSION)
或 cmake_policy(VERSION)
的调用必须将它们设置为 NEW
。它们的 OLD
行为已从 CMake 中移除。
CMake 3.4 引入,CMake 4.0 移除的策略¶
CMake 3.3 引入,CMake 4.0 移除的策略¶
CMake 3.2 引入,CMake 4.0 移除的策略¶
CMake 3.1 引入,CMake 4.0 移除的策略¶
CMake 3.0 引入,CMake 4.0 移除的策略¶
- CMP0050: 禁止 add_custom_command SOURCE 签名。
- CMP0049: 不展开目标源条目中的变量。
- CMP0048: project() 命令管理 VERSION 变量。
- CMP0047: 在 QNX 上对 qcc 驱动程序使用 QCC 编译器 ID。
- CMP0046: add_dependencies 中不存在的依赖项会报错。
- CMP0045: get_target_property 中不存在的目标会报错。
- CMP0044: 区分大小写的 Lang_COMPILER_ID 生成器表达式。
- CMP0043: 忽略 COMPILE_DEFINITIONS_Config 属性。
- CMP0042: MACOSX_RPATH 默认启用。
- CMP0041: 带有生成器表达式的相对包含会报错。
- CMP0040: add_custom_command() 的 TARGET 签名中的目标必须存在。
- CMP0039: 实用程序目标不能有链接依赖项。
- CMP0038: 目标不能直接链接到自身。
- CMP0037: 目标名称不应被保留,并且应匹配有效性模式。
- CMP0036: 不应调用 build_name 命令。
- CMP0035: 不应调用 variable_requires 命令。
- CMP0034: 不应调用 utility_source 命令。
- CMP0033: 不应调用 export_library_dependencies 命令。
- CMP0032: 不应调用 output_required_files 命令。
- CMP0031: 不应调用 load_command 命令。
- CMP0030: 不应调用 use_mangled_mesa 命令。
- CMP0029: 不应调用 subdir_depends 命令。
- CMP0028: 目标名称中的双冒号表示 ALIAS 或 IMPORTED 目标。
- CMP0027: 带有缺失包含目录的有条件链接的导入目标。
- CMP0026: 禁止使用 LOCATION 目标属性。
- CMP0025: Apple Clang 的编译器 ID 现在是 AppleClang。
- CMP0024: 禁止包含导出结果。
CMake 2.8 引入,CMake 4.0 移除的策略¶
- CMP0023: 纯目标和关键字目标链接库签名不能混用。
- CMP0022: INTERFACE_LINK_LIBRARIES 定义链接接口。
- CMP0021: INCLUDE_DIRECTORIES 目标属性中的相对路径会致命错误。
- CMP0020: 在 Windows 上自动将 Qt 可执行文件链接到 qtmain 目标。
- CMP0019: 不在包含和链接信息中重新展开变量。
- CMP0018: 忽略 CMAKE_SHARED_LIBRARY_Lang_FLAGS 变量。
- CMP0017: 从 CMake 模块目录包含文件时,优先使用该目录中的文件。
- CMP0016: target_link_libraries() 如果其唯一参数不是目标,则报告错误。
- CMP0015: link_directories() 将路径视为相对于源目录。
- CMP0014: 输入目录必须有 CMakeLists.txt。
- CMP0013: 不允许重复的二进制目录。
- CMP0012: if() 识别数字和布尔常量。
CMake 2.6 引入,CMake 4.0 移除的策略¶
- CMP0011: 包含的脚本自动执行 cmake_policy PUSH 和 POP。
- CMP0010: 错误的变量引用语法是错误。
- CMP0009: FILE GLOB_RECURSE 调用默认不应跟随符号链接。
- CMP0008: 通过完整路径链接的库必须具有有效的库文件名。
- CMP0007: list 命令不再忽略空元素。
- CMP0006: 安装 MACOSX_BUNDLE 目标需要 BUNDLE DESTINATION。
- CMP0005: 预处理器定义值现在自动转义。
- CMP0004: 链接的库不能有前导或尾随空格。
- CMP0003: 通过完整路径链接的库不再生成链接器搜索路径。
- CMP0002: 逻辑目标名称必须全局唯一。
- CMP0001: 不再使用 CMAKE_BACKWARDS_COMPATIBILITY。
- CMP0000: 必须指定最低要求的 CMake 版本。