diff options
author | Scott Rifenbark <srifenbark@gmail.com> | 2017-09-22 08:31:50 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2017-09-22 17:53:44 +0100 |
commit | f94f6e655fc16213b0980c6f462785dc745dc445 (patch) | |
tree | 10f1a53f218480a5fb97879f630838cb63fcf4c9 /documentation | |
parent | 8f7df8648acf0ed2a5a8bdd01e327240b03f38e8 (diff) | |
download | poky-f94f6e655fc16213b0980c6f462785dc745dc445.tar.gz |
dev-manual, ref-manual: Image format implementation changes
Recently a number of changes have happened on the implementation
side of some image formats, and a few have been renamed.
The u-boot image signing code is now always available and no
longer in a stand-alone file. The vmdk/mdi/qcow2 images have
been removed and are now just a conversion type that is applied
to wic images.
Reported-by: Tom Rini <trini@konsulko.com>
(From yocto-docs rev: ce86da3d48507cee12208e0138c285b4be83d8cd)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/dev-manual/dev-manual-qemu.xml | 8 | ||||
-rw-r--r-- | documentation/ref-manual/migration.xml | 3 | ||||
-rw-r--r-- | documentation/ref-manual/ref-classes.xml | 34 | ||||
-rw-r--r-- | documentation/ref-manual/ref-tasks.xml | 10 | ||||
-rw-r--r-- | documentation/ref-manual/ref-variables.xml | 9 | ||||
-rw-r--r-- | documentation/ref-manual/usingpoky.xml | 8 |
6 files changed, 19 insertions, 53 deletions
diff --git a/documentation/dev-manual/dev-manual-qemu.xml b/documentation/dev-manual/dev-manual-qemu.xml index d127c4f510..89589291fd 100644 --- a/documentation/dev-manual/dev-manual-qemu.xml +++ b/documentation/dev-manual/dev-manual-qemu.xml | |||
@@ -165,14 +165,14 @@ | |||
165 | </literallayout> | 165 | </literallayout> |
166 | </para></listitem> | 166 | </para></listitem> |
167 | <listitem><para> | 167 | <listitem><para> |
168 | This example specifies to boot a virtual machine image | 168 | This example specifies to boot a virtual machine |
169 | (<filename>.vmdk</filename> file). | 169 | image (<filename>.wic.vmdk</filename> file). |
170 | From the <filename>.vmdk</filename>, | 170 | From the <filename>.wic.vmdk</filename>, |
171 | <filename>runqemu</filename> determines the QEMU | 171 | <filename>runqemu</filename> determines the QEMU |
172 | architecture (<replaceable>MACHINE</replaceable>) to be | 172 | architecture (<replaceable>MACHINE</replaceable>) to be |
173 | "qemux86" and the root filesystem type to be "vmdk". | 173 | "qemux86" and the root filesystem type to be "vmdk". |
174 | <literallayout class='monospaced'> | 174 | <literallayout class='monospaced'> |
175 | $ runqemu /home/scott-lenovo/vm/core-image-minimal-qemux86.vmdk | 175 | $ runqemu /home/scott-lenovo/vm/core-image-minimal-qemux86.wic.vmdk |
176 | </literallayout> | 176 | </literallayout> |
177 | </para></listitem> | 177 | </para></listitem> |
178 | </itemizedlist> | 178 | </itemizedlist> |
diff --git a/documentation/ref-manual/migration.xml b/documentation/ref-manual/migration.xml index 11605608e7..f4905acd61 100644 --- a/documentation/ref-manual/migration.xml +++ b/documentation/ref-manual/migration.xml | |||
@@ -3000,8 +3000,7 @@ | |||
3000 | from <filename>autotools</filename> instead. | 3000 | from <filename>autotools</filename> instead. |
3001 | </para></listitem> | 3001 | </para></listitem> |
3002 | <listitem><para><filename>boot-directdisk</filename>: | 3002 | <listitem><para><filename>boot-directdisk</filename>: |
3003 | Merged into the | 3003 | Merged into the <filename>image-vm</filename> |
3004 | <link linkend='ref-classes-image-vm'><filename>image-vm</filename></link> | ||
3005 | class. | 3004 | class. |
3006 | The <filename>boot-directdisk</filename> class was rarely | 3005 | The <filename>boot-directdisk</filename> class was rarely |
3007 | directly used. | 3006 | directly used. |
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml index 4dd67578c3..48468c7f89 100644 --- a/documentation/ref-manual/ref-classes.xml +++ b/documentation/ref-manual/ref-classes.xml | |||
@@ -1286,14 +1286,15 @@ | |||
1286 | <filename>image_types</filename> must also appear in | 1286 | <filename>image_types</filename> must also appear in |
1287 | <filename>IMAGE_CLASSES</filename>. | 1287 | <filename>IMAGE_CLASSES</filename>. |
1288 | </para> | 1288 | </para> |
1289 | </section> | ||
1290 | |||
1291 | <section id='ref-classes-image_types_uboot'> | ||
1292 | <title><filename>image_types_uboot.bbclass</filename></title> | ||
1293 | 1289 | ||
1294 | <para> | 1290 | <para> |
1295 | The <filename>image_types_uboot</filename> class | 1291 | This class also handles conversion and compression of images. |
1296 | defines additional image types specifically for the U-Boot bootloader. | 1292 | <note> |
1293 | To build a VMware VMDK image, you need to add "wic.vmdk" to | ||
1294 | <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link>. | ||
1295 | This would also be similar for Virtual Box Virtual Disk Image | ||
1296 | ("vdi") and QEMU Copy On Write Version 2 ("qcow2") images. | ||
1297 | </note> | ||
1297 | </para> | 1298 | </para> |
1298 | </section> | 1299 | </section> |
1299 | 1300 | ||
@@ -1370,27 +1371,6 @@ | |||
1370 | </para> | 1371 | </para> |
1371 | </section> | 1372 | </section> |
1372 | 1373 | ||
1373 | <section id='ref-classes-image-vm'> | ||
1374 | <title><filename>image-vm.bbclass</filename></title> | ||
1375 | |||
1376 | <para> | ||
1377 | The <filename>image-vm</filename> class supports building VM | ||
1378 | images. | ||
1379 | </para> | ||
1380 | </section> | ||
1381 | |||
1382 | <section id='ref-classes-image-vmdk'> | ||
1383 | <title><filename>image-vmdk.bbclass</filename></title> | ||
1384 | |||
1385 | <para> | ||
1386 | The <filename>image-vmdk</filename> class supports building VMware | ||
1387 | VMDK images. | ||
1388 | Normally, you do not use this class directly. | ||
1389 | Instead, you add "vmdk" to | ||
1390 | <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link>. | ||
1391 | </para> | ||
1392 | </section> | ||
1393 | |||
1394 | <section id='ref-classes-insane'> | 1374 | <section id='ref-classes-insane'> |
1395 | <title><filename>insane.bbclass</filename></title> | 1375 | <title><filename>insane.bbclass</filename></title> |
1396 | 1376 | ||
diff --git a/documentation/ref-manual/ref-tasks.xml b/documentation/ref-manual/ref-tasks.xml index 10c67ab529..2d23bbaabf 100644 --- a/documentation/ref-manual/ref-tasks.xml +++ b/documentation/ref-manual/ref-tasks.xml | |||
@@ -842,16 +842,6 @@ | |||
842 | section in the Yocto Project Development Manual. | 842 | section in the Yocto Project Development Manual. |
843 | </para> | 843 | </para> |
844 | </section> | 844 | </section> |
845 | |||
846 | <section id='ref-tasks-vmdkimg'> | ||
847 | <title><filename>do_vmdkimg</filename></title> | ||
848 | |||
849 | <para> | ||
850 | Creates a <filename>.vmdk</filename> image for use with | ||
851 | <ulink url='http://www.vmware.com/'>VMware</ulink> | ||
852 | and compatible virtual machine hosts. | ||
853 | </para> | ||
854 | </section> | ||
855 | </section> | 845 | </section> |
856 | 846 | ||
857 | <section id='kernel-related-tasks'> | 847 | <section id='kernel-related-tasks'> |
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 8b1ca83938..6f8721199b 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml | |||
@@ -3989,14 +3989,14 @@ | |||
3989 | 3989 | ||
3990 | <glossentry id='var-EFI_PROVIDER'><glossterm>EFI_PROVIDER</glossterm> | 3990 | <glossentry id='var-EFI_PROVIDER'><glossterm>EFI_PROVIDER</glossterm> |
3991 | <info> | 3991 | <info> |
3992 | EFI_PROVIDER[doc] = "When building bootable images (i.e. where hddimg or vmdk is in IMAGE_FSTYPES), the EFI_PROVIDER variable specifies the EFI bootloader to use." | 3992 | EFI_PROVIDER[doc] = "When building bootable images (i.e. where hddimg, iso, or live is in IMAGE_FSTYPES), the EFI_PROVIDER variable specifies the EFI bootloader to use." |
3993 | </info> | 3993 | </info> |
3994 | <glossdef> | 3994 | <glossdef> |
3995 | <para role="glossdeffirst"> | 3995 | <para role="glossdeffirst"> |
3996 | <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> | 3996 | <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> |
3997 | When building bootable images (i.e. where | 3997 | When building bootable images (i.e. where |
3998 | <filename>hddimg</filename> or <filename>vmdk</filename> | 3998 | <filename>hddimg</filename>, <filename>iso</filename>, |
3999 | is in | 3999 | or <filename>vmdk</filename> is in |
4000 | <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link>), | 4000 | <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link>), |
4001 | the <filename>EFI_PROVIDER</filename> variable specifies | 4001 | the <filename>EFI_PROVIDER</filename> variable specifies |
4002 | the EFI bootloader to use. | 4002 | the EFI bootloader to use. |
@@ -6315,7 +6315,6 @@ | |||
6315 | jffs2 | 6315 | jffs2 |
6316 | jffs2.sum | 6316 | jffs2.sum |
6317 | multiubi | 6317 | multiubi |
6318 | qcow2 | ||
6319 | squashfs | 6318 | squashfs |
6320 | squashfs-lzo | 6319 | squashfs-lzo |
6321 | squashfs-xz | 6320 | squashfs-xz |
@@ -6326,8 +6325,6 @@ | |||
6326 | tar.xz | 6325 | tar.xz |
6327 | ubi | 6326 | ubi |
6328 | ubifs | 6327 | ubifs |
6329 | vdi | ||
6330 | vmdk | ||
6331 | wic | 6328 | wic |
6332 | wic.bz2 | 6329 | wic.bz2 |
6333 | wic.gz | 6330 | wic.gz |
diff --git a/documentation/ref-manual/usingpoky.xml b/documentation/ref-manual/usingpoky.xml index a963268347..f0614d5d5b 100644 --- a/documentation/ref-manual/usingpoky.xml +++ b/documentation/ref-manual/usingpoky.xml | |||
@@ -1243,11 +1243,11 @@ | |||
1243 | runqemu qemux86-64 core-image-sato ext4 | 1243 | runqemu qemux86-64 core-image-sato ext4 |
1244 | runqemu qemux86-64 wic-image-minimal wic | 1244 | runqemu qemux86-64 wic-image-minimal wic |
1245 | runqemu path/to/bzImage-qemux86.bin path/to/nfsrootdir/ serial | 1245 | runqemu path/to/bzImage-qemux86.bin path/to/nfsrootdir/ serial |
1246 | runqemu qemux86 iso/hddimg/vmdk/qcow2/vdi/ramfs/cpio.gz... | 1246 | runqemu qemux86 iso/hddimg/wic.vmdk/wic.qcow2/wic.vdi/ramfs/cpio.gz... |
1247 | runqemu qemux86 qemuparams="-m 256" | 1247 | runqemu qemux86 qemuparams="-m 256" |
1248 | runqemu qemux86 bootparams="psplash=false" | 1248 | runqemu qemux86 bootparams="psplash=false" |
1249 | runqemu path/to/<image>-<machine>.vmdk | ||
1250 | runqemu path/to/<image>-<machine>.wic | 1249 | runqemu path/to/<image>-<machine>.wic |
1250 | runqemu path/to/<image>-<machine>.wic.vmdk | ||
1251 | </literallayout> | 1251 | </literallayout> |
1252 | </para> | 1252 | </para> |
1253 | </section> | 1253 | </section> |
@@ -1274,9 +1274,9 @@ | |||
1274 | <listitem><para> | 1274 | <listitem><para> |
1275 | <filename><replaceable>VM</replaceable></filename>: | 1275 | <filename><replaceable>VM</replaceable></filename>: |
1276 | The virtual machine image, which must be a | 1276 | The virtual machine image, which must be a |
1277 | <filename>.vmdk</filename> file. | 1277 | <filename>.wic.vmdk</filename> file. |
1278 | Use this option when you want to boot a | 1278 | Use this option when you want to boot a |
1279 | <filename>.vmdk</filename> image. | 1279 | <filename>.wic.vmdk</filename> image. |
1280 | The image filename you provide must contain one of the | 1280 | The image filename you provide must contain one of the |
1281 | following strings: "qemux86-64", "qemux86", "qemuarm", | 1281 | following strings: "qemux86-64", "qemux86", "qemuarm", |
1282 | "qemumips64", "qemumips", "qemuppc", or "qemush4". | 1282 | "qemumips64", "qemumips", "qemuppc", or "qemush4". |