dev-manual, ref-manual: Added support for WKS_FILE_DEPENDS variable.
Fixes [YOCTO #11017] There is no current way to specify or list plug-in dependencies when building a Wic image. The variable WKS_FILE_DEPENDS was introduced to allow the user to use this in the recipe building the image. I added a description and example of the variable to the ref-manual variable glossary. I also cross-referenced the variable in the "Plug-ins" section of the dev-manual to point to the variable for more information. (From yocto-docs rev: 5a1072499ab80f74ffec6af2cc0b2f1987843a25) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
parent
70872b9468
commit
f574b9f074
|
@ -5038,6 +5038,14 @@
|
||||||
<filename>--source</filename> keyword to a
|
<filename>--source</filename> keyword to a
|
||||||
particular plug-in implementation that populates a
|
particular plug-in implementation that populates a
|
||||||
corresponding partition.
|
corresponding partition.
|
||||||
|
<note>
|
||||||
|
If you use plug-ins that have build-time dependencies
|
||||||
|
(e.g. native tools, bootloaders, and so forth)
|
||||||
|
when building a Wic image, you need to specify those
|
||||||
|
dependencies using the
|
||||||
|
<ulink url='&YOCTO_DOCS_REF_URL;#var-WKS_FILE_DEPENDS'><filename>WKS_FILE_DEPENDS</filename></ulink>
|
||||||
|
variable.
|
||||||
|
</note>
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
|
|
|
@ -15745,6 +15745,50 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
|
||||||
</glossdef>
|
</glossdef>
|
||||||
</glossentry>
|
</glossentry>
|
||||||
|
|
||||||
|
<glossentry id='var-WKS_FILE_DEPENDS'><glossterm>WKS_FILE_DEPENDS</glossterm>
|
||||||
|
<info>
|
||||||
|
WKS_FILE_DEPENDS[doc] = "Lists a recipe's build-time dependencies specific to Wic."
|
||||||
|
</info>
|
||||||
|
<glossdef>
|
||||||
|
<para role="glossdeffirst">
|
||||||
|
When placed in the recipe that builds your image, this
|
||||||
|
variable lists build-time dependencies.
|
||||||
|
The <filename>WKS_FILE_DEPENDS</filename> variable is only
|
||||||
|
applicable when Wic images are active (i.e. when
|
||||||
|
<link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link>
|
||||||
|
contains entries related to Wic).
|
||||||
|
If your recipe does not create Wic images, the variable
|
||||||
|
has no effect.
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
The <filename>WKS_FILE_DEPENDS</filename> variable is
|
||||||
|
similar to the
|
||||||
|
<link linkend='var-DEPENDS'><filename>DEPENDS</filename></link>
|
||||||
|
variable.
|
||||||
|
When you use the variable in your recipe that builds the
|
||||||
|
Wic image, dependencies you list in the
|
||||||
|
<filename>WIC_FILE_DEPENDS</filename> variable are added to
|
||||||
|
the <filename>DEPENDS</filename> variable.
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
With the <filename>WKS_FILE_DEPENDS</filename> variable,
|
||||||
|
you have the possibility to specify a list of additional
|
||||||
|
dependencies (e.g. native tools, bootloaders, and so forth),
|
||||||
|
that are required to build Wic images.
|
||||||
|
Following is an example:
|
||||||
|
<literallayout class='monospaced'>
|
||||||
|
WKS_FILE_DEPENDS = "<replaceable>some-native-tool</replaceable>"
|
||||||
|
</literallayout>
|
||||||
|
In the previous example,
|
||||||
|
<replaceable>some-native-tool</replaceable> would be
|
||||||
|
replaced with an actual native tool on which the build
|
||||||
|
would depend.
|
||||||
|
</para>
|
||||||
|
</glossdef>
|
||||||
|
</glossentry>
|
||||||
|
|
||||||
<glossentry id='var-WKS_FILE'><glossterm>WKS_FILE</glossterm>
|
<glossentry id='var-WKS_FILE'><glossterm>WKS_FILE</glossterm>
|
||||||
<info>
|
<info>
|
||||||
WKS_FILE[doc] = "Specifies the name of the wic kickstart file."
|
WKS_FILE[doc] = "Specifies the name of the wic kickstart file."
|
||||||
|
|
Loading…
Reference in New Issue