* [PATCH v3] sphinx: ref-variables: Added entry for IMAGE_EFI_BOOT_FILES
@ 2020-09-21 11:26 Jamaluddin, Khairul Rohaizzat
2020-09-28 2:39 ` Jamaluddin, Khairul Rohaizzat
0 siblings, 1 reply; 4+ messages in thread
From: Jamaluddin, Khairul Rohaizzat @ 2020-09-21 11:26 UTC (permalink / raw)
To: docs; +Cc: khairul.rohaizzat.jamaluddin
From: Khairul Rohaizzat Jamaluddin <khairul.rohaizzat.jamaluddin@intel.com>
IMAGE_EFI_BOOT_FILES created to help differentiate files needed between
bootimg-efi and bootimg-partition when creating the installer/.wic file.
Signed-off-by: Khairul Rohaizzat Jamaluddin <khairul.rohaizzat.jamaluddin@intel.com>
---
documentation/ref-manual/ref-variables.rst | 38 +++++++++++++++++++++++++++++-
1 file changed, 37 insertions(+), 1 deletion(-)
diff --git a/documentation/ref-manual/ref-variables.rst b/documentation/ref-manual/ref-variables.rst
index 625a37c..c09809e 100644
--- a/documentation/ref-manual/ref-variables.rst
+++ b/documentation/ref-manual/ref-variables.rst
@@ -2902,10 +2902,46 @@ system and gives an overview of their function and contents.
The base name of image output files. This variable defaults to the
recipe name (``${``\ :term:`PN`\ ``}``).
+ IMAGE_EFI_BOOT_FILES
+ A space-separated list of files installed into the boot partition
+ when preparing an image using the Wic tool with the
+ ``bootimg-efi`` source plugin. By default,
+ the files are
+ installed under the same name as the source files. To change the
+ installed name, separate it from the original name with a semi-colon
+ (;). Source files need to be located in
+ :term:`DEPLOY_DIR_IMAGE`. Here are two
+ examples:
+ ::
+
+ IMAGE_EFI_BOOT_FILES = "${KERNEL_IMAGETYPE};bz2"
+ IMAGE_EFI_BOOT_FILES = "${KERNEL_IMAGETYPE} microcode.cpio"
+
+ Alternatively, source files can be picked up using a glob pattern. In
+ this case, the destination file must have the same name as the base
+ name of the source file path. To install files into a directory
+ within the target location, pass its name after a semi-colon (;).
+ Here are two examples:
+ ::
+
+ IMAGE_EFI_BOOT_FILES = "boot/loader/*"
+ IMAGE_EFI_BOOT_FILES = "boot/loader/*;boot/"
+
+ The first example
+ installs all files from ``${DEPLOY_DIR_IMAGE}/boot/loader/``
+ into the root of the target partition. The second example installs
+ the same files into a ``boot`` directory within the target partition.
+
+ You can find information on how to use the Wic tool in the
+ ":ref:`dev-manual/dev-manual-common-tasks:creating partitioned images using wic`"
+ section of the Yocto Project Development Tasks Manual. Reference
+ material for Wic is located in the
+ ":doc:`../ref-manual/ref-kickstart`" chapter.
+
IMAGE_BOOT_FILES
A space-separated list of files installed into the boot partition
when preparing an image using the Wic tool with the
- ``bootimg-partition`` or ``bootimg-efi`` source plugin. By default,
+ ``bootimg-partition`` source plugin. By default,
the files are
installed under the same name as the source files. To change the
installed name, separate it from the original name with a semi-colon
--
2.7.4
^ permalink raw reply related [flat|nested] 4+ messages in thread
* Re: [PATCH v3] sphinx: ref-variables: Added entry for IMAGE_EFI_BOOT_FILES
2020-09-21 11:26 [PATCH v3] sphinx: ref-variables: Added entry for IMAGE_EFI_BOOT_FILES Jamaluddin, Khairul Rohaizzat
@ 2020-09-28 2:39 ` Jamaluddin, Khairul Rohaizzat
2020-09-29 22:30 ` [docs] " Richard Purdie
0 siblings, 1 reply; 4+ messages in thread
From: Jamaluddin, Khairul Rohaizzat @ 2020-09-28 2:39 UTC (permalink / raw)
To: docs
Hi,
Does anyone have any updates on this patch? Does it pass for merge?
Thank you & Kind regards,
Khairul
-----Original Message-----
From: Jamaluddin, Khairul Rohaizzat <khairul.rohaizzat.jamaluddin@intel.com>
Sent: Monday, September 21, 2020 7:27 PM
To: docs@lists.yoctoproject.org
Cc: Jamaluddin, Khairul Rohaizzat <khairul.rohaizzat.jamaluddin@intel.com>
Subject: [PATCH v3] sphinx: ref-variables: Added entry for IMAGE_EFI_BOOT_FILES
From: Khairul Rohaizzat Jamaluddin <khairul.rohaizzat.jamaluddin@intel.com>
IMAGE_EFI_BOOT_FILES created to help differentiate files needed between bootimg-efi and bootimg-partition when creating the installer/.wic file.
Signed-off-by: Khairul Rohaizzat Jamaluddin <khairul.rohaizzat.jamaluddin@intel.com>
---
documentation/ref-manual/ref-variables.rst | 38 +++++++++++++++++++++++++++++-
1 file changed, 37 insertions(+), 1 deletion(-)
diff --git a/documentation/ref-manual/ref-variables.rst b/documentation/ref-manual/ref-variables.rst
index 625a37c..c09809e 100644
--- a/documentation/ref-manual/ref-variables.rst
+++ b/documentation/ref-manual/ref-variables.rst
@@ -2902,10 +2902,46 @@ system and gives an overview of their function and contents.
The base name of image output files. This variable defaults to the
recipe name (``${``\ :term:`PN`\ ``}``).
+ IMAGE_EFI_BOOT_FILES
+ A space-separated list of files installed into the boot partition
+ when preparing an image using the Wic tool with the
+ ``bootimg-efi`` source plugin. By default,
+ the files are
+ installed under the same name as the source files. To change the
+ installed name, separate it from the original name with a semi-colon
+ (;). Source files need to be located in
+ :term:`DEPLOY_DIR_IMAGE`. Here are two
+ examples:
+ ::
+
+ IMAGE_EFI_BOOT_FILES = "${KERNEL_IMAGETYPE};bz2"
+ IMAGE_EFI_BOOT_FILES = "${KERNEL_IMAGETYPE} microcode.cpio"
+
+ Alternatively, source files can be picked up using a glob pattern. In
+ this case, the destination file must have the same name as the base
+ name of the source file path. To install files into a directory
+ within the target location, pass its name after a semi-colon (;).
+ Here are two examples:
+ ::
+
+ IMAGE_EFI_BOOT_FILES = "boot/loader/*"
+ IMAGE_EFI_BOOT_FILES = "boot/loader/*;boot/"
+
+ The first example
+ installs all files from ``${DEPLOY_DIR_IMAGE}/boot/loader/``
+ into the root of the target partition. The second example installs
+ the same files into a ``boot`` directory within the target partition.
+
+ You can find information on how to use the Wic tool in the
+ ":ref:`dev-manual/dev-manual-common-tasks:creating partitioned images using wic`"
+ section of the Yocto Project Development Tasks Manual. Reference
+ material for Wic is located in the
+ ":doc:`../ref-manual/ref-kickstart`" chapter.
+
IMAGE_BOOT_FILES
A space-separated list of files installed into the boot partition
when preparing an image using the Wic tool with the
- ``bootimg-partition`` or ``bootimg-efi`` source plugin. By default,
+ ``bootimg-partition`` source plugin. By default,
the files are
installed under the same name as the source files. To change the
installed name, separate it from the original name with a semi-colon
--
2.7.4
^ permalink raw reply related [flat|nested] 4+ messages in thread
* Re: [docs] [PATCH v3] sphinx: ref-variables: Added entry for IMAGE_EFI_BOOT_FILES
2020-09-28 2:39 ` Jamaluddin, Khairul Rohaizzat
@ 2020-09-29 22:30 ` Richard Purdie
2020-09-30 2:22 ` Jamaluddin, Khairul Rohaizzat
0 siblings, 1 reply; 4+ messages in thread
From: Richard Purdie @ 2020-09-29 22:30 UTC (permalink / raw)
To: Jamaluddin, Khairul Rohaizzat, docs
On Mon, 2020-09-28 at 02:39 +0000, Jamaluddin, Khairul Rohaizzat wrote:
> Hi,
>
> Does anyone have any updates on this patch? Does it pass for merge?
Sorry, there was some confusion over who was merging patches. Its in
now, thanks!
Cheers,
Richard
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [docs] [PATCH v3] sphinx: ref-variables: Added entry for IMAGE_EFI_BOOT_FILES
2020-09-29 22:30 ` [docs] " Richard Purdie
@ 2020-09-30 2:22 ` Jamaluddin, Khairul Rohaizzat
0 siblings, 0 replies; 4+ messages in thread
From: Jamaluddin, Khairul Rohaizzat @ 2020-09-30 2:22 UTC (permalink / raw)
To: Richard Purdie, docs
Thanks for the help, Richard!
Thank you & Kind regards,
Khairul
-----Original Message-----
From: docs@lists.yoctoproject.org <docs@lists.yoctoproject.org> On Behalf Of Richard Purdie
Sent: Wednesday, September 30, 2020 6:30 AM
To: Jamaluddin, Khairul Rohaizzat <khairul.rohaizzat.jamaluddin@intel.com>; docs@lists.yoctoproject.org
Subject: Re: [docs] [PATCH v3] sphinx: ref-variables: Added entry for IMAGE_EFI_BOOT_FILES
On Mon, 2020-09-28 at 02:39 +0000, Jamaluddin, Khairul Rohaizzat wrote:
> Hi,
>
> Does anyone have any updates on this patch? Does it pass for merge?
Sorry, there was some confusion over who was merging patches. Its in now, thanks!
Cheers,
Richard
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2020-09-30 2:24 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-09-21 11:26 [PATCH v3] sphinx: ref-variables: Added entry for IMAGE_EFI_BOOT_FILES Jamaluddin, Khairul Rohaizzat
2020-09-28 2:39 ` Jamaluddin, Khairul Rohaizzat
2020-09-29 22:30 ` [docs] " Richard Purdie
2020-09-30 2:22 ` Jamaluddin, Khairul Rohaizzat
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.