diff mbox series

[v3,1/2] doc: ref-variables: add LAYERSERIES_COMPAT to term glossary

Message ID 20230301131611.16265-1-fawzi.khaber@smile.fr
State Accepted, archived
Commit cbad8cb28a8134d6b2053ef5c2e04bb455fc798b
Headers show
Series [v3,1/2] doc: ref-variables: add LAYERSERIES_COMPAT to term glossary | expand

Commit Message

Fawzi KHABER March 1, 2023, 1:16 p.m. UTC 
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(+)

Comments

Michael Opdenacker March 2, 2023, 1:44 p.m. UTC | #1 
Hi Fawzi,

Thanks for the update!

On 01.03.23 at 14:16, Fawzi KHABER wrote:
> Bitbake throws a warning if the layer compatibility is not defined since
> cca81e33b58c390dcf5cc3a31555a43b79177166. This variable did not figure in
> the documentation.

I'd replace the second sentence by:
"The description of this variable comes from the Yocto Project manual".

This way, we will know where the text comes from in the unlikely case
there is a copyright dispute. That will help too as I plan to update the
YP manual with just a reference to this description in the BitBake manual.

For all the rest:
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
(note that I'm not the maintainer of BitBake's manual, Richard is).

Cheers
Michael.
Fawzi KHABER March 2, 2023, 3:27 p.m. UTC | #2 
Hi Michael,

Thanks for the review, i ll send the v4
diff mbox series

Patch

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