ref-manual: Added LAYERRECOMMENDS variable description

Fixes [YOCTO #11579]

Added a new description for the LAYERRECOMMENDS variable.

(From yocto-docs rev: 3004a5724c4ea7165e4f749f9c9237ee1fbd89f5)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark
2017-06-02 07:17:43 -07:00
committed by Richard Purdie
parent 078408643e
commit d4503fbf26

View File

@@ -7485,6 +7485,38 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
</glossdef>
</glossentry>
<glossentry id='var-LAYERRECOMMENDS'><glossterm>LAYERRECOMMENDS</glossterm>
<info>
LAYERRECOMMENDS[doc] = "Lists the layers, separated by spaces, recommended for use with this layer."
</info>
<glossdef>
<para role="glossdeffirst">
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
Lists the layers, separated by spaces, recommended for
use with this layer.
Optionally, you can specify a specific layer version for a
recommendation by adding the version to the end of the
layer name.
Here is an example:
<literallayout class='monospaced'>
LAYERRECOMMENDS_mylayer = "anotherlayer (=3)"
</literallayout>
In this previous example, version 3 of "anotherlayer" is
compared against
<filename>LAYERVERSION_anotherlayer</filename>.
</para>
<para>
An error is produced if any dependency is missing or the
version numbers (if specified) do not match exactly.
This variable is used in the
<filename>conf/layer.conf</filename> file and must be
suffixed with the name of the specific layer (e.g.
<filename>LAYERRECOMMENDS_mylayer</filename>).
</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."