ref-manual: Updated LAYERDEPENDS variable description

Fixes [YOCTO #11579]

The syntax for specifying a layer version was incorrect. I
have added an explanation for the correct syntax and provided
an example.

(From yocto-docs rev: 83c97473defbbac35ebca81f4ef69289f3dd8789)

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-05-25 06:54:06 -07:00 committed by Richard Purdie
parent aade3895d4
commit e9a2e5ae36
1 changed files with 20 additions and 11 deletions

View File

@ -7441,21 +7441,30 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
<glossentry id='var-LAYERDEPENDS'><glossterm>LAYERDEPENDS</glossterm> <glossentry id='var-LAYERDEPENDS'><glossterm>LAYERDEPENDS</glossterm>
<info> <info>
LAYERDEPENDS[doc] = "Lists the layers, separated by spaces, upon which this recipe depends. This variable is used in the conf/layer.conf file and must be suffixed with the name of the specific layer." LAYERDEPENDS[doc] = "Lists the layers, separated by spaces, on which this recipe depends. This variable is used in the conf/layer.conf file and must be suffixed with the name of the specific layer."
</info> </info>
<glossdef> <glossdef>
<para role="glossdeffirst"> <para role="glossdeffirst">
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
Lists the layers that this recipe depends upon, separated by spaces. Lists the layers, separated by spaces, on which this
Optionally, you can specify a specific layer version for a dependency recipe depends.
by adding it to the end of the layer name with a colon, (e.g. "anotherlayer:3" Optionally, you can specify a specific layer version for a
to be compared against dependency by adding it to the end of the layer name.
<link linkend='var-LAYERVERSION'><filename>LAYERVERSION</filename></link><filename>_anotherlayer</filename> Here is an example:
in this case). <literallayout class='monospaced'>
An error will be produced if any dependency is missing or LAYERDEPENDS_mylayer = "anotherlayer (=3)"
the version numbers do not match exactly (if specified). </literallayout>
This variable is used in the <filename>conf/layer.conf</filename> file In this previous example, version 3 of "anotherlayer"
and must be suffixed with the name of the specific layer (e.g. is compared against
<link linkend='var-LAYERVERSION'><filename>LAYERVERSION</filename></link><filename>_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>LAYERDEPENDS_mylayer</filename>). <filename>LAYERDEPENDS_mylayer</filename>).
</para> </para>
</glossdef> </glossdef>