5.1.4. Making Sure Your Layer is Compatible With Yocto Project

When you create a layer used with the Yocto Project, it is advantageous to make sure that the layer interacts well with existing Yocto Project layers (i.e. the layer is compatible with the Yocto Project). Ensuring compatibility makes the layer easy to be consumed by others in the Yocto Project community and allows you permission to use the Yocto Project Compatibility logo.

Version 1.0 of the Yocto Project Compatibility Program has been in existence for a number of releases. This version of the program consists of the layer application process that requests permission to use the Yocto Project Compatibility logo for your layer and application. You can find version 1.0 of the form at https://www.yoctoproject.org/webform/yocto-project-compatible-registration. To be granted permission to use the logo, you need to be able to answer "Yes" to the questions or have an acceptable explanation for any questions answered "No".

A second version (2.0) of the Yocto Project Compatibility Program is currently under development. Included as part of version 2.0 (and currently available) is the yocto-compat-layer.py script. When run against a layer, this script tests the layer against tighter constraints based on experiences of how layers have worked in the real world and where pitfalls have been found.

Part of the 2.0 version of the program that is not currently available but is in development is an updated compatibility application form. This updated form, among other questions, specifically asks if your layer has passed the test using the yocto-compat-layer.py script.

Tip

Even though the updated application form is currently unavailable for version 2.0 of the Yocto Project Compatibility Program, the yocto-compat-layer.py script is available in OE-Core. You can use the script to assess the status of your layers in advance of the 2.0 release of the program.

The remainder of this section presents information on the version 1.0 registration form and on the yocto-compat-layer.py script.