diff options
author | Scott Rifenbark <srifenbark@gmail.com> | 2018-03-26 11:20:09 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2018-05-24 17:17:42 +0100 |
commit | 40e4b8683630a947b60665b6d260650c605de9f6 (patch) | |
tree | 84e33dbbed4a229b2cea4bcecdab51ee51a22058 | |
parent | c047d598905ce407af55f30c7d6d6e9b068b34aa (diff) | |
download | poky-40e4b8683630a947b60665b6d260650c605de9f6.tar.gz |
ref-manual: Updated the IMAGE_BOOT_FILES varaible.
Added a final paragraph that provides some cross-referencing to
the sections that describe how to use Wic and to the Wic
reference chapter.
Also, shortened the DOC info line.
(From yocto-docs rev: 4ba5d0119caa3696187537f5b4cc9c64ca00e205)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r-- | documentation/ref-manual/ref-variables.xml | 25 |
1 files changed, 16 insertions, 9 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 8b529f38f8..9a41e43d07 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml | |||
@@ -5720,18 +5720,17 @@ | |||
5720 | 5720 | ||
5721 | <glossentry id='var-IMAGE_BOOT_FILES'><glossterm>IMAGE_BOOT_FILES</glossterm> | 5721 | <glossentry id='var-IMAGE_BOOT_FILES'><glossterm>IMAGE_BOOT_FILES</glossterm> |
5722 | <info> | 5722 | <info> |
5723 | IMAGE_BOOT_FILES[doc] = "A space-separated list of files from ${DEPLOY_DIR_IMAGE} to place in boot partition. Entries will be installed under a same name as the source file. To change the destination file name, pass a desired name after a semicolon (eg. u-boot.img;uboot)." | 5723 | IMAGE_BOOT_FILES[doc] = "A space-separated list of files from ${DEPLOY_DIR_IMAGE} to place in boot partition." |
5724 | </info> | 5724 | </info> |
5725 | <glossdef> | 5725 | <glossdef> |
5726 | <para role="glossdeffirst"> | 5726 | <para role="glossdeffirst"> |
5727 | <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> | 5727 | <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> |
5728 | A space-separated list of files installed into the | 5728 | A space-separated list of files installed into the |
5729 | boot partition when preparing an image using the | 5729 | boot partition when preparing an image using the Wic tool |
5730 | <filename>wic</filename> tool with the | 5730 | with the <filename>bootimg-partition</filename> source |
5731 | <filename>bootimg-partition</filename> source | ||
5732 | plugin. | 5731 | plugin. |
5733 | By default, the files are installed under | 5732 | By default, the files are installed under the same name as |
5734 | the same name as the source files. | 5733 | the source files. |
5735 | To change the installed name, separate it from the | 5734 | To change the installed name, separate it from the |
5736 | original name with a semi-colon (;). | 5735 | original name with a semi-colon (;). |
5737 | Source files need to be located in | 5736 | Source files need to be located in |
@@ -5747,9 +5746,8 @@ | |||
5747 | <para> | 5746 | <para> |
5748 | Alternatively, source files can be picked up using | 5747 | Alternatively, source files can be picked up using |
5749 | a glob pattern. | 5748 | a glob pattern. |
5750 | In this case, the destination file | 5749 | In this case, the destination file must have the same name |
5751 | will have the same name as the base name of the source file | 5750 | as the base name of the source file path. |
5752 | path. | ||
5753 | To install files into a directory within the | 5751 | To install files into a directory within the |
5754 | target location, pass its name after a semi-colon | 5752 | target location, pass its name after a semi-colon |
5755 | (;). | 5753 | (;). |
@@ -5765,6 +5763,15 @@ | |||
5765 | <filename>boot</filename> directory within the | 5763 | <filename>boot</filename> directory within the |
5766 | target partition. | 5764 | target partition. |
5767 | </para> | 5765 | </para> |
5766 | |||
5767 | <para> | ||
5768 | You can find information on how to use the Wic tool in the | ||
5769 | "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-partitioned-images-using-wic'>Creating Partitioned Images Using Wic</ulink>" | ||
5770 | section of the Yocto Project Development Tasks Manual. | ||
5771 | Reference material for Wic is located in the | ||
5772 | "<ulink url='&YOCTO_DOCS_REF_URL;#ref-kickstart'>OpenEmbedded Kickstart (.wks) Reference</ulink>" | ||
5773 | chapter in the Yocto Project Reference Manual. | ||
5774 | </para> | ||
5768 | </glossdef> | 5775 | </glossdef> |
5769 | </glossentry> | 5776 | </glossentry> |
5770 | 5777 | ||