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 @@ --source keyword to a particular plug-in implementation that populates a corresponding partition. + + 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 + WKS_FILE_DEPENDS + variable. + 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" + WKS_FILE_DEPENDS + + WKS_FILE_DEPENDS[doc] = "Lists a recipe's build-time dependencies specific to Wic." + + + + When placed in the recipe that builds your image, this + variable lists build-time dependencies. + The WKS_FILE_DEPENDS variable is only + applicable when Wic images are active (i.e. when + IMAGE_FSTYPES + contains entries related to Wic). + If your recipe does not create Wic images, the variable + has no effect. + + + + The WKS_FILE_DEPENDS variable is + similar to the + DEPENDS + variable. + When you use the variable in your recipe that builds the + Wic image, dependencies you list in the + WIC_FILE_DEPENDS variable are added to + the DEPENDS variable. + + + + With the WKS_FILE_DEPENDS 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: + + WKS_FILE_DEPENDS = "some-native-tool" + + In the previous example, + some-native-tool would be + replaced with an actual native tool on which the build + would depend. + + + + WKS_FILE WKS_FILE[doc] = "Specifies the name of the wic kickstart file."