summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml8
-rw-r--r--documentation/ref-manual/ref-variables.xml44
2 files changed, 52 insertions, 0 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index ca3feb287d..cdcb1ecbc0 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -5038,6 +5038,14 @@
5038 <filename>--source</filename> keyword to a 5038 <filename>--source</filename> keyword to a
5039 particular plug-in implementation that populates a 5039 particular plug-in implementation that populates a
5040 corresponding partition. 5040 corresponding partition.
5041 <note>
5042 If you use plug-ins that have build-time dependencies
5043 (e.g. native tools, bootloaders, and so forth)
5044 when building a Wic image, you need to specify those
5045 dependencies using the
5046 <ulink url='&YOCTO_DOCS_REF_URL;#var-WKS_FILE_DEPENDS'><filename>WKS_FILE_DEPENDS</filename></ulink>
5047 variable.
5048 </note>
5041 </para> 5049 </para>
5042 5050
5043 <para> 5051 <para>
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."