diff options
authorScott Rifenbark <>2016-12-12 17:00:51 -0800
committerRichard Purdie <>2017-01-11 17:23:10 +0000
commitac6773117afa6fef5383b7d1c23d139f32568c5d (patch)
parent13d9371e40b2d78188dd75b05d3ebf4b948f9e45 (diff)
ref-manual: Added WKS_FILE description for new variable
This new variable points to the location of the wics kickstart file. (From yocto-docs rev: 6d9a7220ed41c8a512eccbad0ae170072d40fc6f) Signed-off-by: Scott Rifenbark <> Signed-off-by: Richard Purdie <>
1 files changed, 20 insertions, 0 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 4e003cdba4..7e08f76cc7 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -15548,6 +15548,26 @@ recipes-graphics/xorg-font/ = "${INC_PR}.3"
+ <glossentry id='var-WKS_FILE'><glossterm>WKS_FILE</glossterm>
+ <info>
+ WKS_FILE[doc] = "Specifies the name of the wic kickstart file."
+ </info>
+ <glossdef>
+ <para role="glossdeffirst">
+ Specifies the location of the Wic
+ kickstart file that is used by the OpenEmbedded build
+ system to create a Wic-partitioned image
+ (<replaceable>image</replaceable><filename>.wic</filename>).
+ For information on how to create a
+ Wic-partitioned image, see the
+ "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-wic-images-oe'>Creating Wic-Partitioned Images</ulink>"
+ section.
+ For details on the kickstart file format, see the
+ "<ulink url='&YOCTO_DOCS_DEV_URL;#openembedded-kickstart-wks-reference'>OpenEmbedded Kickstart (<filename>.wks</filename>) Reference</ulink>.
+ </para>
+ </glossdef>
+ </glossentry>
<glossentry id='var-WORKDIR'><glossterm>WORKDIR</glossterm>
WORKDIR[doc] = "The pathname of the working directory in which the OpenEmbedded build system builds a recipe. This directory is located within the TMPDIR directory structure and changes as different packages are built."