manuals: add documentation for WKS_FILES
PATCH 1/1 manuals: add documentation for WKS_FILES
From: Michael Opdenacker <[email protected]>
Fixes [YOCTO #14590]
--- documentation/dev-manual/common-tasks.rst | 4 +++- documentation/ref-manual/variables.rst | 13 +++++++++++++ 2 files changed, 16 insertions(+), 1 deletion(-)
documentation/dev-manual/common-tasks.rst +3 -1
@@ -5481,7 +5481,9 @@ system needs to meet the following requirements: variable. - Include the name of the :ref:`wic kickstart file <openembedded-kickstart-wks-reference>` - as part of the :term:`WKS_FILE` variable + as part of the :term:`WKS_FILE` variable. If multiple candidate files can + be provided by different layers, specify all the possible names through the + :term:`WKS_FILES` variable instead. Getting Help ------------
documentation/ref-manual/variables.rst +13 -0
@@ -8767,6 +8767,19 @@ system and gives an overview of their function and contents. previous example, some-native-tool would be replaced with an actual native tool on which the build would depend. + :term:`WKS_FILES` + Specified a list of candidate Wic kickstart files to be used by the + OpenEmbedded build system to create a partitioned image. Only the + first one that is found, from left to right, will be used. + + This is only useful when there are multiple ``.wks`` that can be used + to produce an image. A typical case is when multiple layers are used + for different hardware platforms, each supplying a different + ``.wks`` file. In this case, you specify all possible ones through + :term:`WKS_FILES`. + + If only one ``.wks`` file is used, set :term:`WKS_FILE` instead. + :term:`WORKDIR` The pathname of the work directory in which the OpenEmbedded build system builds a recipe. This directory is located within the
Signature · 1 line
2.25.1
Hi Michael,
Quoted 30 lines · Michael Opdenacker via lists.yoctoproject.org
From: Michael Opdenacker <[email protected]>
Fixes [YOCTO #14590]
Signed-off-by Michael Opdenacker <[email protected]>--- documentation/dev-manual/common-tasks.rst | 4 +++- documentation/ref-manual/variables.rst | 13 +++++++++++++ 2 files changed, 16 insertions(+), 1 deletion(-)documentation/dev-manual/common-tasks.rst +3
-1@@ -5481,7 +5481,9 @@ system needs to meet the following requirements: variable. - Include the name of the :ref:`wic kickstart file <openembedded-kickstart-wks-reference>` - as part of the :term:`WKS_FILE` variable + as part of the :term:`WKS_FILE` variable. If multiple candidate files can + be provided by different layers, specify all the possible names through the + :term:`WKS_FILES` variable instead. Getting Help ------------documentation/ref-manual/variables.rst +0
-0
documentation/ref-manual/variables.rst system and gives an overview of their function and contents. · line 8771
Quoted 5 lines
documentation/ref-manual/variables.rst +2
-0@@ -8767,6 +8767,19 @@ system and gives an overview of their function and contents. previous example, some-native-tool would be replaced with an actual native tool on which the build would depend. + :term:`WKS_FILES` + Specified a list of candidate Wic kickstart files to be used by the
s/Specified/Specifies/
documentation/ref-manual/variables.rst system and gives an overview of their function and contents. · line 8775
Quoted 4 lines
documentation/ref-manual/variables.rst +4
-0+ OpenEmbedded build system to create a partitioned image. Only the + first one that is found, from left to right, will be used. + + This is only useful when there are multiple ``.wks`` that can be used
+files ?
Looks good otherwise, thanks!
Cheers,
Quentin
A message that is not in the archive (sent off-list or not yet received): [email protected]
Hi Michael,
Quoted 62 lines · Michael Opdenacker
Hi Quentin
Many thanks for the review!
Quoted 37 lines · Quentin Schulz
Hi Michael,
Quoted 34 lines · Michael Opdenacker via lists.yoctoproject.org
From: Michael Opdenacker <[email protected]>
Fixes [YOCTO #14590]
Signed-off-by Michael Opdenacker <[email protected]>--- documentation/dev-manual/common-tasks.rst | 4 +++- documentation/ref-manual/variables.rst | 13 +++++++++++++ 2 files changed, 16 insertions(+), 1 deletion(-)documentation/dev-manual/common-tasks.rst +0
-0@@ -5481,7 +5481,9 @@ system needs to meet the following requirements: variable. - Include the name of the :ref:`wic kickstart file<openembedded-kickstart-wks-reference>`
- as part of the :term:WKS_FILEvariable
+ as part of the :term:WKS_FILEvariable. If multiple candidate files can
+ be provided by different layers, specify all the possible names through the
+ :term:WKS_FILESvariable instead.
Getting Help
------------documentation/ref-manual/variables.rst +0
-0@@ -8767,6 +8767,19 @@ system and gives an overview of their functionand contents.
Quoted 8 lines
Quoted 6 lines
previous example, some-native-tool would be replaced with an
actual
native tool on which the build would depend.
+ :term:WKS_FILES
+ Specified a list of candidate Wic kickstart files to be used by thes/Specified/Specifies/
Oops, fixed.
Quoted 8 lines
Quoted 6 lines
+ OpenEmbedded build system to create a partitioned image. Only the + first one that is found, from left to right, will be used. +
+ This is only useful when there are multiple ``.wks`` that can be used+files ?
Quoted 8 lines
Indeed. Good catch.
Quoted 3 lines
Looks good otherwise, thanks!
Great, can I add your "Reviewed-by"? The changes are now in master-next.
Sure. Don't worry if you forget it sometimes, I don't care too much about them as a reviewer :)
Cheers,
Quentin