summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-variables.xml
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2017-03-20 09:31:33 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2017-03-24 23:44:02 +0000
commitf574b9f0749a8979ce8980608bb5dbb23906f913 (patch)
tree9ac372b369274bca573af42367e1143a3b652603 /documentation/ref-manual/ref-variables.xml
parent70872b9468f3d9fffd7670c2562753631bd0f1e0 (diff)
downloadpoky-f574b9f0749a8979ce8980608bb5dbb23906f913.tar.gz
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>
Diffstat (limited to 'documentation/ref-manual/ref-variables.xml')
-rw-r--r--documentation/ref-manual/ref-variables.xml44
1 files changed, 44 insertions, 0 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index fb293d7556..4a42c5c00e 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -15745,6 +15745,50 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
15745 </glossdef> 15745 </glossdef>
15746 </glossentry> 15746 </glossentry>
15747 15747
15748 <glossentry id='var-WKS_FILE_DEPENDS'><glossterm>WKS_FILE_DEPENDS</glossterm>
15749 <info>
15750 WKS_FILE_DEPENDS[doc] = "Lists a recipe's build-time dependencies specific to Wic."
15751 </info>
15752 <glossdef>
15753 <para role="glossdeffirst">
15754 When placed in the recipe that builds your image, this
15755 variable lists build-time dependencies.
15756 The <filename>WKS_FILE_DEPENDS</filename> variable is only
15757 applicable when Wic images are active (i.e. when
15758 <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link>
15759 contains entries related to Wic).
15760 If your recipe does not create Wic images, the variable
15761 has no effect.
15762 </para>
15763
15764 <para>
15765 The <filename>WKS_FILE_DEPENDS</filename> variable is
15766 similar to the
15767 <link linkend='var-DEPENDS'><filename>DEPENDS</filename></link>
15768 variable.
15769 When you use the variable in your recipe that builds the
15770 Wic image, dependencies you list in the
15771 <filename>WIC_FILE_DEPENDS</filename> variable are added to
15772 the <filename>DEPENDS</filename> variable.
15773 </para>
15774
15775 <para>
15776 With the <filename>WKS_FILE_DEPENDS</filename> variable,
15777 you have the possibility to specify a list of additional
15778 dependencies (e.g. native tools, bootloaders, and so forth),
15779 that are required to build Wic images.
15780 Following is an example:
15781 <literallayout class='monospaced'>
15782 WKS_FILE_DEPENDS = "<replaceable>some-native-tool</replaceable>"
15783 </literallayout>
15784 In the previous example,
15785 <replaceable>some-native-tool</replaceable> would be
15786 replaced with an actual native tool on which the build
15787 would depend.
15788 </para>
15789 </glossdef>
15790 </glossentry>
15791
15748 <glossentry id='var-WKS_FILE'><glossterm>WKS_FILE</glossterm> 15792 <glossentry id='var-WKS_FILE'><glossterm>WKS_FILE</glossterm>
15749 <info> 15793 <info>
15750 WKS_FILE[doc] = "Specifies the name of the wic kickstart file." 15794 WKS_FILE[doc] = "Specifies the name of the wic kickstart file."