| Message ID | 20230227135115.29202-1-fawzi.khaber@smile.fr |
|---|---|
| State | Accepted, archived |
| Commit | cbad8cb28a8134d6b2053ef5c2e04bb455fc798b |
| Headers | show |
| Series | [v2,1/2] doc: ref-variables: add LAYERSERIES_COMPAT to term glossary | expand |
Hi Fawzi Thanks for the patch! Not a big deal, but next time you send patches for the BitBake manual, don't forget to copy the docs@lists.yoctoproject.org mailing list too. This will help getting reviews. See my comments below... On 27.02.23 at 14:51, Fawzi KHABER wrote: > Bitbake throws a warning if the layer compatibility is not defined since > cca81e33b58c390dcf5cc3a31555a43b79177166. This variable did not figure in > the documentation. > > Reviewed-by: Ever ATILANO <ever.atilano@smile.fr> > Reviewed-by: Yoann CONGAL <yoann.congal@smile.fr> > Signed-off-by: Fawzi KHABER <fawzi.khaber@smile.fr> > --- > .../bitbake-user-manual-ref-variables.rst | 23 +++++++++++++++++++ > 1 file changed, 23 insertions(+) > > diff --git a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst > index 09d09a8d..a48e7000 100644 > --- a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst > +++ b/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 This corresponds to one of BitBake variables which were documented in the Yocto Project manual, but not in the BitBake manual. This is a good idea to migrate their description to the BitBake manual, and once the change is accepted, I'll be happy to update the entry in the YP manual to be just a reference to the variable entry in the BitBake manual. However, I'd suggest to modify the commit description, to provide an accurate description of where the text comes from: "Bitbake throws a warning if the layer compatibility is not defined since cca81e33b58c390dcf5cc3a31555a43b79177166. However, this variable was not described in the BitBake manual. Taking the description of this variable in the Yocto Project manual." Thanks again Cheers Michael
diff --git a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst index 09d09a8d..a48e7000 100644 --- a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst +++ b/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