二进制兼容性

此插件位于缓存中的 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 值(针对相同的编译器和编译器版本)构建的二进制文件是二进制兼容的,并且可以无缝链接。

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

从 Conan 2.4 开始,compiler.cstd 设置可用。它只会在计算包的 package_id 时被考虑,前提是其包配方明确声明了 languages = "C" 属性。

一些重要规则

  • 内置的 compatibility.py 在未来的版本中可能会发生变化。为了避免将来被更新,请删除第一行注释 # This file was generated by Conan.

警告

compatibility.py 功能处于 预览阶段。当前的默认 compatibility.py实验性的。请参阅 Conan 稳定性 部分以获取更多信息。

另请参阅

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