cmake-policies(7)¶
简介¶
CMake 策略在引入行为变更的同时,保持对现有项目版本的兼容性。策略是一种弃用机制,而非功能开关。每个策略文档都会记录一个被弃用的 OLD(旧)行为和一个首选的 NEW(新)行为。项目必须随着时间的推移进行更新以使用 NEW 行为,但其现有版本将继续使用 OLD 行为正常工作。
更新项目¶
当某个版本的 CMake 引入新策略时,其 OLD 行为会立即在该版本及后续版本中被弃用。项目应尽快更新以使用策略的 NEW 行为。
使用 cmake_minimum_required() 命令来记录项目已更新至的最新 CMake 版本。例如:
cmake_minimum_required(VERSION 3.10...4.2)
这使用了 <min>...<policy_max> 语法,以启用 CMake 4.2 及更早版本中引入的策略的 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.3 引入的策略¶
CMake 4.2 引入的策略¶
CMake 4.1 引入的策略¶
- CMP0197: MSVC 链接 -machine: 标志不在 CMAKE_*_LINKER_FLAGS 中。
- CMP0196: CMakeDetermineVSServicePack 模块被移除。
- CMP0195: 构建树中的 Swift 模块使用 Swift 模块目录结构。
- CMP0194: 对于语言 ASM,MSVC 不再被视为汇编器。
- 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() 总是将 <PROJECT-NAME>_* 设置为普通变量。
- 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 生成器中默认启用每机安装。
- 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: URL 下载方式的 ExternalProject 和 FetchContent 默认忽略归档中的时间戳。
- CMP0134: 当 "TARGET" 视图不可用时,回退到 "HOST" Windows 注册表视图。
- CMP0133: CPack 模块默认在 CPack DragNDrop 生成器中禁用 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: 不允许包含 export 结果。
CMake 2.8 引入,CMake 4.0 移除的策略¶
- CMP0023: 不能混合使用普通和关键字 target_link_libraries 签名。
- 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 的最低要求版本。