diff options
author | Khairul Rohaizzat Jamaluddin <khairul.rohaizzat.jamaluddin@intel.com> | 2020-09-21 19:26:55 +0800 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-09-29 23:29:36 +0100 |
commit | 65b9ceee4a2ec0bef9d7cc4248dde3d59c2009a2 (patch) | |
tree | 497631bcad0020989ee589b9936686dd84dc4d44 | |
parent | 4ec1fa047f8247f254d755cbaa7c84e54bb1e672 (diff) | |
download | poky-65b9ceee4a2ec0bef9d7cc4248dde3d59c2009a2.tar.gz |
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 <khairul.rohaizzat.jamaluddin@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r-- | documentation/ref-manual/ref-variables.rst | 38 |
1 files changed, 37 insertions, 1 deletions
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. | |||
2902 | The base name of image output files. This variable defaults to the | 2902 | The base name of image output files. This variable defaults to the |
2903 | recipe name (``${``\ :term:`PN`\ ``}``). | 2903 | recipe name (``${``\ :term:`PN`\ ``}``). |
2904 | 2904 | ||
2905 | IMAGE_EFI_BOOT_FILES | ||
2906 | A space-separated list of files installed into the boot partition | ||
2907 | when preparing an image using the Wic tool with the | ||
2908 | ``bootimg-efi`` source plugin. By default, | ||
2909 | the files are | ||
2910 | installed under the same name as the source files. To change the | ||
2911 | installed name, separate it from the original name with a semi-colon | ||
2912 | (;). Source files need to be located in | ||
2913 | :term:`DEPLOY_DIR_IMAGE`. Here are two | ||
2914 | examples: | ||
2915 | :: | ||
2916 | |||
2917 | IMAGE_EFI_BOOT_FILES = "${KERNEL_IMAGETYPE};bz2" | ||
2918 | IMAGE_EFI_BOOT_FILES = "${KERNEL_IMAGETYPE} microcode.cpio" | ||
2919 | |||
2920 | Alternatively, source files can be picked up using a glob pattern. In | ||
2921 | this case, the destination file must have the same name as the base | ||
2922 | name of the source file path. To install files into a directory | ||
2923 | within the target location, pass its name after a semi-colon (;). | ||
2924 | Here are two examples: | ||
2925 | :: | ||
2926 | |||
2927 | IMAGE_EFI_BOOT_FILES = "boot/loader/*" | ||
2928 | IMAGE_EFI_BOOT_FILES = "boot/loader/*;boot/" | ||
2929 | |||
2930 | The first example | ||
2931 | installs all files from ``${DEPLOY_DIR_IMAGE}/boot/loader/`` | ||
2932 | into the root of the target partition. The second example installs | ||
2933 | the same files into a ``boot`` directory within the target partition. | ||
2934 | |||
2935 | You can find information on how to use the Wic tool in the | ||
2936 | ":ref:`dev-manual/dev-manual-common-tasks:creating partitioned images using wic`" | ||
2937 | section of the Yocto Project Development Tasks Manual. Reference | ||
2938 | material for Wic is located in the | ||
2939 | ":doc:`../ref-manual/ref-kickstart`" chapter. | ||
2940 | |||
2905 | IMAGE_BOOT_FILES | 2941 | IMAGE_BOOT_FILES |
2906 | A space-separated list of files installed into the boot partition | 2942 | A space-separated list of files installed into the boot partition |
2907 | when preparing an image using the Wic tool with the | 2943 | when preparing an image using the Wic tool with the |
2908 | ``bootimg-partition`` or ``bootimg-efi`` source plugin. By default, | 2944 | ``bootimg-partition`` source plugin. By default, |
2909 | the files are | 2945 | the files are |
2910 | installed under the same name as the source files. To change the | 2946 | installed under the same name as the source files. To change the |
2911 | installed name, separate it from the original name with a semi-colon | 2947 | installed name, separate it from the original name with a semi-colon |