二进制兼容性

此插件位于缓存 extensions/plugins/compatibility/compatibility.py 中,允许定义跨设置和选项的软件包二进制兼容性的自定义规则。它实现了一些内置的逻辑,但可以自定义。

接口是一个名为 def compatibility(conanfile) 的单个函数,它接收一个 conanfile 对象作为参数。它的返回值将等于 compatibility() 配方方法,它是 settingsoptions 的有序变体列表,这些变体被认为是二进制兼容的。Conan 将按顺序检查该列表是否存在二进制文件,直到找到一个二进制文件为止。以下是有效的语法(但不是一个有用或有效的方法,例如,它会在 Windows 中失败):

def compatibility(conanfile):
    result = []
    if conanfile.settings.build_type == "Debug":
        result.append({"settings": [("build_type", "Release")]})
    return result

Conan 提供了一个默认的 compatibility.py 实现,它实现了不同 compiler.cppstdcompiler.cstd 值的二进制兼容性。也就是说,默认情况下,它假设使用不同的 cppstdcstd 值(对于相同的编译器和编译器版本)构建的二进制文件是二进制兼容的,并且可以毫无问题地链接在一起。

在大多数 C++ 场景中,必须在配置文件中定义 compiler.cppstd。如果不存在给定 compiler.cppstd 值的二进制文件(这意味着,使用该设置精确构建的二进制文件),Conan 默认的 compatibility.py 将迭代该编译器版本支持的 cppstd 值。可以为任何特定软件包禁用此行为,只需将 extension_properties = {"compatibility_cppstd": False} 属性添加到软件包 conanfile.py 配方中,请阅读 extension_properties 文档

从 Conan 2.4 开始,可以使用 compiler.cstd 设置。仅当配方显式声明 languages = "C" 属性时,才会在计算软件包 package_id 时考虑该设置。

一些重要规则

  • 内置的 compatibility.py 将在未来的版本中进行更改。为了避免将来被更新,请删除第一条注释 # This file was generated by Conan.

警告

compatibility.py 功能处于预览状态。当前默认的 compatibility.py实验性的。有关更多信息,请参阅 Conan 稳定性 部分。

另请参阅

请阅读 二进制模型参考,以全面了解 Conan 二进制模型。