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>
This commit is contained in:
Scott Rifenbark
2017-09-22 08:31:50 -07:00
committed by Richard Purdie
parent 8f7df8648a
commit f94f6e655f
6 changed files with 19 additions and 53 deletions

View File

@@ -165,14 +165,14 @@
</literallayout>
</para></listitem>
<listitem><para>
This example specifies to boot a virtual machine image
(<filename>.vmdk</filename> file).
From the <filename>.vmdk</filename>,
This example specifies to boot a virtual machine
image (<filename>.wic.vmdk</filename> file).
From the <filename>.wic.vmdk</filename>,
<filename>runqemu</filename> determines the QEMU
architecture (<replaceable>MACHINE</replaceable>) to be
"qemux86" and the root filesystem type to be "vmdk".
<literallayout class='monospaced'>
$ runqemu /home/scott-lenovo/vm/core-image-minimal-qemux86.vmdk
$ runqemu /home/scott-lenovo/vm/core-image-minimal-qemux86.wic.vmdk
</literallayout>
</para></listitem>
</itemizedlist>

View File

@@ -3000,8 +3000,7 @@
from <filename>autotools</filename> instead.
</para></listitem>
<listitem><para><filename>boot-directdisk</filename>:
Merged into the
<link linkend='ref-classes-image-vm'><filename>image-vm</filename></link>
Merged into the <filename>image-vm</filename>
class.
The <filename>boot-directdisk</filename> class was rarely
directly used.

View File

@@ -1286,14 +1286,15 @@
<filename>image_types</filename> must also appear in
<filename>IMAGE_CLASSES</filename>.
</para>
</section>
<section id='ref-classes-image_types_uboot'>
<title><filename>image_types_uboot.bbclass</filename></title>
<para>
The <filename>image_types_uboot</filename> class
defines additional image types specifically for the U-Boot bootloader.
This class also handles conversion and compression of images.
<note>
To build a VMware VMDK image, you need to add "wic.vmdk" to
<link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link>.
This would also be similar for Virtual Box Virtual Disk Image
("vdi") and QEMU Copy On Write Version 2 ("qcow2") images.
</note>
</para>
</section>
@@ -1370,27 +1371,6 @@
</para>
</section>
<section id='ref-classes-image-vm'>
<title><filename>image-vm.bbclass</filename></title>
<para>
The <filename>image-vm</filename> class supports building VM
images.
</para>
</section>
<section id='ref-classes-image-vmdk'>
<title><filename>image-vmdk.bbclass</filename></title>
<para>
The <filename>image-vmdk</filename> class supports building VMware
VMDK images.
Normally, you do not use this class directly.
Instead, you add "vmdk" to
<link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link>.
</para>
</section>
<section id='ref-classes-insane'>
<title><filename>insane.bbclass</filename></title>

View File

@@ -842,16 +842,6 @@
section in the Yocto Project Development Manual.
</para>
</section>
<section id='ref-tasks-vmdkimg'>
<title><filename>do_vmdkimg</filename></title>
<para>
Creates a <filename>.vmdk</filename> image for use with
<ulink url='http://www.vmware.com/'>VMware</ulink>
and compatible virtual machine hosts.
</para>
</section>
</section>
<section id='kernel-related-tasks'>

View File

@@ -3989,14 +3989,14 @@
<glossentry id='var-EFI_PROVIDER'><glossterm>EFI_PROVIDER</glossterm>
<info>
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."
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."
</info>
<glossdef>
<para role="glossdeffirst">
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
When building bootable images (i.e. where
<filename>hddimg</filename> or <filename>vmdk</filename>
is in
<filename>hddimg</filename>, <filename>iso</filename>,
or <filename>vmdk</filename> is in
<link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link>),
the <filename>EFI_PROVIDER</filename> variable specifies
the EFI bootloader to use.
@@ -6315,7 +6315,6 @@
jffs2
jffs2.sum
multiubi
qcow2
squashfs
squashfs-lzo
squashfs-xz
@@ -6326,8 +6325,6 @@
tar.xz
ubi
ubifs
vdi
vmdk
wic
wic.bz2
wic.gz

View File

@@ -1243,11 +1243,11 @@
runqemu qemux86-64 core-image-sato ext4
runqemu qemux86-64 wic-image-minimal wic
runqemu path/to/bzImage-qemux86.bin path/to/nfsrootdir/ serial
runqemu qemux86 iso/hddimg/vmdk/qcow2/vdi/ramfs/cpio.gz...
runqemu qemux86 iso/hddimg/wic.vmdk/wic.qcow2/wic.vdi/ramfs/cpio.gz...
runqemu qemux86 qemuparams="-m 256"
runqemu qemux86 bootparams="psplash=false"
runqemu path/to/&lt;image&gt;-&lt;machine&gt;.vmdk
runqemu path/to/&lt;image&gt;-&lt;machine&gt;.wic
runqemu path/to/&lt;image&gt;-&lt;machine&gt;.wic.vmdk
</literallayout>
</para>
</section>
@@ -1274,9 +1274,9 @@
<listitem><para>
<filename><replaceable>VM</replaceable></filename>:
The virtual machine image, which must be a
<filename>.vmdk</filename> file.
<filename>.wic.vmdk</filename> file.
Use this option when you want to boot a
<filename>.vmdk</filename> image.
<filename>.wic.vmdk</filename> image.
The image filename you provide must contain one of the
following strings: "qemux86-64", "qemux86", "qemuarm",
"qemumips64", "qemumips", "qemuppc", or "qemush4".