mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-03-19 13:49:41 +01:00
Code Issues Packages Projects Releases Wiki Activity

ref-manual: Added new variable description LAYERSERIES_COMPAT

Browse Source 
Created a new variable description in the glossary.  This
variable is used in the layer.conf file and needed to be
documented.

(From yocto-docs rev: 5c514c0e90ca920bdf183b1f9449a06b906235ca)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark
2018-03-23 12:14:28 -07:00
committed by Richard Purdie
parent cc24d4b4f8
commit 6b8a529dbf
1 changed files with 44 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
documentation/ref-manual/ref-variables.xml
View File

@@ -7812,6 +7812,50 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
</glossdef>
</glossentry>
<glossentry id='var-LAYERSERIES_COMPAT'><glossterm>LAYERSERIES_COMPAT</glossterm>
<info>
LAYERSERIES_COMPAT[doc] = "Lists the versions of the OpenEmbedded Core project for which a layer is compatible."
</info>
<glossdef>
<para role="glossdeffirst">
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
Lists the versions of the
<link linkend='oe-core'>OpenEmbedded Core</link> project
for which a layer is compatible.
Using the <filename>LAYERSERIES_COMPAT</filename> variable
makes it clear when a given layer is unmaintained and
untested with new releases of OE-Core.
</para>
<para>
To specify the OE-Core projects for which a layer is
compatible, use this variable in your layer's
<filename>conf/layer.conf</filename> configuration file.
For the list, use the Yocto Project
<ulink url='https://wiki.yoctoproject.org/wiki/Releases'>Release Name</ulink>
(e.g. &DISTRO_NAME_NO_CAP;).
To specify multiple OE-Core projects for the layer,
use a space-separated list:
<literallayout class='monospaced'>
LAYERSERIES_COMPAT_<replaceable>layer_root_name</replaceable> = "&DISTRO_NAME_NO_CAP; &DISTRO_NAME_NO_CAP_MINUS_ONE;"
</literallayout>
<note>
Setting <filename>LAYERSERIES_COMPAT</filename> 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.
</note>
</para>
<para>
See the
"<ulink url='&YOCTO_DOCS_DEV_URL;#creating-your-own-layer'>Creating Your Own Layer</ulink>"
section in the Yocto Project Development Tasks Manual.
</para>
</glossdef>
</glossentry>
<glossentry id='var-LAYERVERSION'><glossterm>LAYERVERSION</glossterm>
<info>
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."