summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2022-05-20 19:54:38 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2022-05-24 13:58:47 +0100
commitb192b8059310d98438c6cdb0b6a76fba119875ed (patch)
tree5fb621bf91c5d21a713cdaa7135869e502465905
parente8d6e05000bc32e5c536638f47e188a2266afb02 (diff)
downloadpoky-b192b8059310d98438c6cdb0b6a76fba119875ed.tar.gz
manuals: add documentation for WKS_FILES
Fixes [YOCTO #14590] (From yocto-docs rev: e736ff92b5b09f2028f3e8a5152973941d25dae4) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/dev-manual/common-tasks.rst4
-rw-r--r--documentation/ref-manual/variables.rst13
2 files changed, 16 insertions, 1 deletions
diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
index 3a47a9ff27..ca6d594386 100644
--- a/documentation/dev-manual/common-tasks.rst
+++ b/documentation/dev-manual/common-tasks.rst
@@ -5481,7 +5481,9 @@ system needs to meet the following requirements:
5481 variable. 5481 variable.
5482 5482
5483- Include the name of the :ref:`wic kickstart file <openembedded-kickstart-wks-reference>` 5483- Include the name of the :ref:`wic kickstart file <openembedded-kickstart-wks-reference>`
5484 as part of the :term:`WKS_FILE` variable 5484 as part of the :term:`WKS_FILE` variable. If multiple candidate files can
5485 be provided by different layers, specify all the possible names through the
5486 :term:`WKS_FILES` variable instead.
5485 5487
5486Getting Help 5488Getting Help
5487------------ 5489------------
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 146af89e8c..367b4674e2 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -8767,6 +8767,19 @@ system and gives an overview of their function and contents.
8767 previous example, some-native-tool would be replaced with an actual 8767 previous example, some-native-tool would be replaced with an actual
8768 native tool on which the build would depend. 8768 native tool on which the build would depend.
8769 8769
8770 :term:`WKS_FILES`
8771 Specifies a list of candidate Wic kickstart files to be used by the
8772 OpenEmbedded build system to create a partitioned image. Only the
8773 first one that is found, from left to right, will be used.
8774
8775 This is only useful when there are multiple ``.wks`` files that can be
8776 used to produce an image. A typical case is when multiple layers are
8777 used for different hardware platforms, each supplying a different
8778 ``.wks`` file. In this case, you specify all possible ones through
8779 :term:`WKS_FILES`.
8780
8781 If only one ``.wks`` file is used, set :term:`WKS_FILE` instead.
8782
8770 :term:`WORKDIR` 8783 :term:`WORKDIR`
8771 The pathname of the work directory in which the OpenEmbedded build 8784 The pathname of the work directory in which the OpenEmbedded build
8772 system builds a recipe. This directory is located within the 8785 system builds a recipe. This directory is located within the