summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2017-06-02 07:17:43 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2017-06-04 08:47:14 +0100
commitd4503fbf26a2bb2d169348a143b77c0e1d2b5f07 (patch)
tree4c1bc415b65b46af9160d757d56dabaec7c3f010 /documentation/ref-manual
parent078408643e080fea021a1e80d3ffab110dab8356 (diff)
downloadpoky-d4503fbf26a2bb2d169348a143b77c0e1d2b5f07.tar.gz
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>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/ref-variables.xml32
1 files changed, 32 insertions, 0 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 163f5760e1..4a2c79f1be 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -7485,6 +7485,38 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
7485 </glossdef> 7485 </glossdef>
7486 </glossentry> 7486 </glossentry>
7487 7487
7488 <glossentry id='var-LAYERRECOMMENDS'><glossterm>LAYERRECOMMENDS</glossterm>
7489 <info>
7490 LAYERRECOMMENDS[doc] = "Lists the layers, separated by spaces, recommended for use with this layer."
7491 </info>
7492 <glossdef>
7493 <para role="glossdeffirst">
7494<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
7495 Lists the layers, separated by spaces, recommended for
7496 use with this layer.
7497 Optionally, you can specify a specific layer version for a
7498 recommendation by adding the version to the end of the
7499 layer name.
7500 Here is an example:
7501 <literallayout class='monospaced'>
7502 LAYERRECOMMENDS_mylayer = "anotherlayer (=3)"
7503 </literallayout>
7504 In this previous example, version 3 of "anotherlayer" is
7505 compared against
7506 <filename>LAYERVERSION_anotherlayer</filename>.
7507 </para>
7508
7509 <para>
7510 An error is produced if any dependency is missing or the
7511 version numbers (if specified) do not match exactly.
7512 This variable is used in the
7513 <filename>conf/layer.conf</filename> file and must be
7514 suffixed with the name of the specific layer (e.g.
7515 <filename>LAYERRECOMMENDS_mylayer</filename>).
7516 </para>
7517 </glossdef>
7518 </glossentry>
7519
7488 <glossentry id='var-LAYERVERSION'><glossterm>LAYERVERSION</glossterm> 7520 <glossentry id='var-LAYERVERSION'><glossterm>LAYERVERSION</glossterm>
7489 <info> 7521 <info>
7490 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." 7522 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."