From 28e334e8a481a8d3b159f7d7cb3f8eb3e7b5c2fa Mon Sep 17 00:00:00 2001 From: Fawzi KHABER Date: Thu, 2 Mar 2023 17:14:30 +0100 Subject: bitbake: doc: ref-variables: add LAYERSERIES_COMPAT to term glossary Bitbake throws a warning if the layer compatibility is not defined since cca81e33b58c390dcf5cc3a31555a43b79177166. The description of this variable comes from the Yocto Project manual. Reviewed-by: Michael Opdenacker Reviewed-by: Ever ATILANO Reviewed-by: Yoann CONGAL (Bitbake rev: cbad8cb28a8134d6b2053ef5c2e04bb455fc798b) Signed-off-by: Fawzi KHABER Signed-off-by: Richard Purdie --- .../bitbake-user-manual-ref-variables.rst | 23 ++++++++++++++++++++++ 1 file changed, 23 insertions(+) (limited to 'bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst') diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst index 09d09a8d9e..a48e700030 100644 --- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst @@ -1096,6 +1096,29 @@ overview of their function and contents. variable is not available outside of ``layer.conf`` and references are expanded immediately when parsing of the file completes. + :term:`LAYERSERIES_COMPAT` + Lists the versions of the OpenEmbedded-Core (OE-Core) for which + a layer is compatible. Using the :term:`LAYERSERIES_COMPAT` variable + allows the layer maintainer to indicate which combinations of the + layer and OE-Core can be expected to work. The variable gives the + system a way to detect when a layer has not been tested with new + releases of OE-Core (e.g. the layer is not maintained). + + To specify the OE-Core versions 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. "kirkstone", + "mickledore"). To specify multiple OE-Core versions for the layer, use + a space-separated list:: + + LAYERSERIES_COMPAT_layer_root_name = "kirkstone mickledore" + + .. note:: + + Setting :term:`LAYERSERIES_COMPAT` is required by the Yocto Project + Compatible version 2 standard. + The OpenEmbedded build system produces a warning if the variable + is not set for any given layer. + :term:`LAYERVERSION` Optionally specifies the version of a layer as a single number. You can use this variable within -- cgit v1.2.3-54-g00ecf