5.1.4.2. yocto-compat-layer.py Script

The yocto-compat-layer.py script, which is currently available, provides you a way to assess how compatible your layer is with the Yocto Project. You should run this script prior to using the form to apply for compatibility as described in the previous section.

Note

Because the script is part of the 2.0 release of the Yocto Project Compatibility Program, you are not required to successfully run your layer against it in order to be granted compatibility status. However, it is a good idea as it promotes well-behaved layers and gives you an idea of where your layer stands regarding compatibility.

The script divides tests into three areas: COMMON, BSD, and DISTRO. For example, given a distribution layer (DISTRO), the layer must pass both the COMMON and DISTRO related tests. Furthermore, if your layer is a BSP layer, the layer must pass the COMMON and BSP set of tests.

To execute the script, enter the following commands from your build directory:

     $ source oe-init-build-env
     $ yocto-compat-layer.py your_layer_directory
                    

Be sure to provide the actual directory for your layer as part of the command.

Entering the command causes the script to determine the type of layer and then to execute a set of specific tests against the layer. The following list overviews the test: