diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 7ba1c576f6..3e68350335 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml @@ -7812,6 +7812,50 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" + LAYERSERIES_COMPAT + + LAYERSERIES_COMPAT[doc] = "Lists the versions of the OpenEmbedded Core project for which a layer is compatible." + + + + + Lists the versions of the + OpenEmbedded Core project + for which a layer is compatible. + Using the LAYERSERIES_COMPAT variable + makes it clear when a given layer is unmaintained and + untested with new releases of OE-Core. + + + + To specify the OE-Core projects for which a layer is + compatible, use this variable in your layer's + conf/layer.conf configuration file. + For the list, use the Yocto Project + Release Name + (e.g. &DISTRO_NAME_NO_CAP;). + To specify multiple OE-Core projects for the layer, + use a space-separated list: + + LAYERSERIES_COMPAT_layer_root_name = "&DISTRO_NAME_NO_CAP; &DISTRO_NAME_NO_CAP_MINUS_ONE;" + + + Setting LAYERSERIES_COMPAT is + required by the Yocto Project Compatible version 2 + standard. + The OpenEmbedded build system, however, does not + produce and error if the variable is not set. + + + + + See the + "Creating Your Own Layer" + section in the Yocto Project Development Tasks Manual. + + + + LAYERVERSION LAYERVERSION[doc] = "Optionally specifies the version of a layer as a single number. This variable is used in the conf/layer.conf file and must be suffixed with the name of the specific layer."