From 65b9ceee4a2ec0bef9d7cc4248dde3d59c2009a2 Mon Sep 17 00:00:00 2001 From: Khairul Rohaizzat Jamaluddin Date: Mon, 21 Sep 2020 19:26:55 +0800 Subject: sphinx: ref-variables: Added entry for IMAGE_EFI_BOOT_FILES IMAGE_EFI_BOOT_FILES created to help differentiate files needed between bootimg-efi and bootimg-partition when creating the installer/.wic file. (From yocto-docs rev: 3430e56aaa8a528a062af534610dc60346347947) Signed-off-by: Khairul Rohaizzat Jamaluddin Signed-off-by: Richard Purdie --- 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 c49c208bc0..cf37703814 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 -- cgit v1.2.3-54-g00ecf